Class InstancePoolsClient

Index

Constructors

Methods

createInstancePool deleteInstancePool editInstancePool getInstancePool listInstancePools

Constructors

constructor

new InstancePoolsClient(options: ClientOptions): InstancePoolsClient
Parameters
- options: ClientOptions
Returns InstancePoolsClient
- Defined in client.ts:60

Methods

createInstancePool

createInstancePool(
req: CreateInstancePoolRequest,
options?: CallOptions,
): Promise<CreateInstancePoolResponse>
Creates a new instance pool using idle and ready-to-use cloud instances.
Parameters
- req: CreateInstancePoolRequest
- Optionaloptions: CallOptions
Returns Promise<CreateInstancePoolResponse>
- Defined in client.ts:76

deleteInstancePool

deleteInstancePool(
req: DeleteInstancePoolRequest,
options?: CallOptions,
): Promise<DeleteInstancePoolResponse>
Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.
Parameters
- req: DeleteInstancePoolRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteInstancePoolResponse>
- Defined in client.ts:106

editInstancePool

editInstancePool(
req: EditInstancePoolRequest,
options?: CallOptions,
): Promise<EditInstancePoolResponse>
Modifies the configuration of an existing instance pool.
Parameters
- req: EditInstancePoolRequest
- Optionaloptions: CallOptions
Returns Promise<EditInstancePoolResponse>
- Defined in client.ts:136

getInstancePool

getInstancePool(
req: GetInstancePoolRequest,
options?: CallOptions,
): Promise<GetInstancePoolResponse>
Retrieve the information for an instance pool based on its identifier.
Parameters
- req: GetInstancePoolRequest
- Optionaloptions: CallOptions
Returns Promise<GetInstancePoolResponse>
- Defined in client.ts:166

listInstancePools

listInstancePools(
_req: ListInstancePoolsRequest,
options?: CallOptions,
): Promise<ListInstancePoolsResponse>
Gets a list of instance pools with their statistics.
Parameters
- _req: ListInstancePoolsRequest
- Optionaloptions: CallOptions
Returns Promise<ListInstancePoolsResponse>
- Defined in client.ts:201