Class PoolService

constructor

• new PoolService(sdk: SDKInterface): PoolService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns PoolService

$type

create

• create(
      request: CreatePoolRequest,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

• create(
      request: CreatePoolRequest,
      metadata: Metadata,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest
  • metadata: Metadata

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

• create(
      request: CreatePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

• create(
      request: CreatePoolRequest,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

• create(
      request: CreatePoolRequest,
      metadata: Metadata,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest
  • metadata: Metadata

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

• create(
      request: CreatePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreatePoolRequest, Operation<GetOperationRequest>>

  Creates a new pool with the specified configuration.

  Parameters

  • request: CreatePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreatePoolRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeletePoolRequest,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

• delete(
      request: DeletePoolRequest,
      metadata: Metadata,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest
  • metadata: Metadata

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

• delete(
      request: DeletePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

• delete(
      request: DeletePoolRequest,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

• delete(
      request: DeletePoolRequest,
      metadata: Metadata,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest
  • metadata: Metadata

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

• delete(
      request: DeletePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeletePoolRequest, Operation<GetOperationRequest>>

  Deletes a pool by its ID.

  Parameters

  • request: DeletePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeletePoolRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListPoolsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Pool>

  Calls the filter method.

  Parameters

  • request: ListPoolsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Pool>

• filter(
      request: ListPoolsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Pool>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListPoolsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Pool>

get

• get(request: GetPoolRequest): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest

  Returns Request<GetPoolRequest, Pool>

• get(request: GetPoolRequest, metadata: Metadata): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata

  Returns Request<GetPoolRequest, Pool>

• get(
      request: GetPoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetPoolRequest, Pool>

• get(request: GetPoolRequest): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest

  Returns Request<GetPoolRequest, Pool>

• get(request: GetPoolRequest, metadata: Metadata): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata

  Returns Request<GetPoolRequest, Pool>

• get(
      request: GetPoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetPoolRequest, Pool>

  Retrieves a pool by its ID.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetPoolRequest, Pool>

getByName

• getByName(request: GetPoolByNameRequest): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest

  Returns Request<GetPoolByNameRequest, Pool>

• getByName(
      request: GetPoolByNameRequest,
      metadata: Metadata,
  ): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata

  Returns Request<GetPoolByNameRequest, Pool>

• getByName(
      request: GetPoolByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetPoolByNameRequest, Pool>

• getByName(request: GetPoolByNameRequest): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest

  Returns Request<GetPoolByNameRequest, Pool>

• getByName(
      request: GetPoolByNameRequest,
      metadata: Metadata,
  ): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata

  Returns Request<GetPoolByNameRequest, Pool>

• getByName(
      request: GetPoolByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetPoolByNameRequest, Pool>

  Retrieves a pool by its name within a specified parent.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetPoolByNameRequest, Pool>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(request: ListPoolsRequest): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest

  Returns Request<ListPoolsRequest, ListPoolsResponse>

• list(
      request: ListPoolsRequest,
      metadata: Metadata,
  ): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata

  Returns Request<ListPoolsRequest, ListPoolsResponse>

• list(
      request: ListPoolsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPoolsRequest, ListPoolsResponse>

• list(request: ListPoolsRequest): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest

  Returns Request<ListPoolsRequest, ListPoolsResponse>

• list(
      request: ListPoolsRequest,
      metadata: Metadata,
  ): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata

  Returns Request<ListPoolsRequest, ListPoolsResponse>

• list(
      request: ListPoolsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPoolsRequest, ListPoolsResponse>

  Lists pools within a specified parent.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPoolsRequest, ListPoolsResponse>

listAggregated

• listAggregated(
      request: ListAggregatedPoolsRequest,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

• listAggregated(
      request: ListAggregatedPoolsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

• listAggregated(
      request: ListAggregatedPoolsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

• listAggregated(
      request: ListAggregatedPoolsRequest,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

• listAggregated(
      request: ListAggregatedPoolsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

• listAggregated(
      request: ListAggregatedPoolsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedPoolsRequest, ListPoolsResponse>

  Lists pools across regions for the specified parent.

  Parameters

  • request: ListAggregatedPoolsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedPoolsRequest, ListPoolsResponse>

listBySourcePool

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
      metadata: Metadata,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest
  • metadata: Metadata

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
      metadata: Metadata,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest
  • metadata: Metadata

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

• listBySourcePool(
      request: ListPoolsBySourcePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

  Lists pools that use a specified pool as their source.

  Parameters

  • request: ListPoolsBySourcePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListPoolsBySourcePoolRequest, ListPoolsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdatePoolRequest,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>

• update(
      request: UpdatePoolRequest,
      metadata: Metadata,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest
  • metadata: Metadata

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>

• update(
      request: UpdatePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>

• update(
      request: UpdatePoolRequest,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>

• update(
      request: UpdatePoolRequest,
      metadata: Metadata,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest
  • metadata: Metadata

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>

• update(
      request: UpdatePoolRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdatePoolRequest, Operation<GetOperationRequest>>

  Updates an existing pool with new configuration parameters.

  Parameters

  • request: UpdatePoolRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdatePoolRequest, Operation<GetOperationRequest>>