Class PoolService

constructor

• new PoolService(sdk: SDKInterface): PoolService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns PoolService

$type

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>

  Calls the Get RPC.

  Parameters

  • request: GetPoolRequest

  Returns Request<GetPoolRequest, Pool>

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

  Calls the Get RPC.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata

  Returns Request<GetPoolRequest, Pool>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetPoolRequest, Pool>

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

  Calls the Get RPC.

  Parameters

  • request: GetPoolRequest

  Returns Request<GetPoolRequest, Pool>

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

  Calls the Get RPC.

  Parameters

  • request: GetPoolRequest
  • metadata: Metadata

  Returns Request<GetPoolRequest, Pool>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetPoolRequest, Pool>

getByName

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

  Calls the GetByName RPC.

  Parameters

  • request: GetPoolByNameRequest

  Returns Request<GetPoolByNameRequest, Pool>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata

  Returns Request<GetPoolByNameRequest, Pool>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetPoolByNameRequest, Pool>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetPoolByNameRequest

  Returns Request<GetPoolByNameRequest, Pool>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetPoolByNameRequest
  • metadata: Metadata

  Returns Request<GetPoolByNameRequest, Pool>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetPoolByNameRequest, Pool>

list

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

  Calls the List RPC.

  Parameters

  • request: ListPoolsRequest

  Returns Request<ListPoolsRequest, ListPoolsResponse>

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

  Calls the List RPC.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata

  Returns Request<ListPoolsRequest, ListPoolsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListPoolsRequest, ListPoolsResponse>

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

  Calls the List RPC.

  Parameters

  • request: ListPoolsRequest

  Returns Request<ListPoolsRequest, ListPoolsResponse>

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

  Calls the List RPC.

  Parameters

  • request: ListPoolsRequest
  • metadata: Metadata

  Returns Request<ListPoolsRequest, ListPoolsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListPoolsRequest, ListPoolsResponse>