Class ClusterService

constructor

• new ClusterService(sdk: SDKInterface): ClusterService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns ClusterService

$type

create

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

  Creates a cluster.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a cluster.

  Parameters

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

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a cluster.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a cluster.

  Parameters

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

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

delete

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

  Delete a cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Delete a cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Delete a cluster.

  Parameters

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

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Delete a cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Delete a cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Delete a cluster.

  Parameters

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

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Cluster>

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

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

  Parameters

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

  Returns AsyncGenerator<Cluster>

get

• get(request: GetClusterRequest): Request<GetClusterRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
  ): Request<GetClusterRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified cluster.

  Parameters

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

  Returns Request<GetClusterRequest, Cluster>

• get(request: GetClusterRequest): Request<GetClusterRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
  ): Request<GetClusterRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified cluster.

  Parameters

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

  Returns Request<GetClusterRequest, Cluster>

getByName

• getByName(
      request: GetClusterByNameRequest,
  ): Request<GetClusterByNameRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterByNameRequest

  Returns Request<GetClusterByNameRequest, Cluster>

• getByName(
      request: GetClusterByNameRequest,
      metadata: Metadata,
  ): Request<GetClusterByNameRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterByNameRequest
  • metadata: Metadata

  Returns Request<GetClusterByNameRequest, Cluster>

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

  Returns the specified cluster.

  Parameters

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

  Returns Request<GetClusterByNameRequest, Cluster>

• getByName(
      request: GetClusterByNameRequest,
  ): Request<GetClusterByNameRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterByNameRequest

  Returns Request<GetClusterByNameRequest, Cluster>

• getByName(
      request: GetClusterByNameRequest,
      metadata: Metadata,
  ): Request<GetClusterByNameRequest, Cluster>

  Returns the specified cluster.

  Parameters

  • request: GetClusterByNameRequest
  • metadata: Metadata

  Returns Request<GetClusterByNameRequest, Cluster>

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

  Returns the specified cluster.

  Parameters

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

  Returns Request<GetClusterByNameRequest, Cluster>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListClustersRequest,
  ): Request<ListClustersRequest, ListClustersResponse>

  Retrieves a list of clusters.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
  ): Request<ListClustersRequest, ListClustersResponse>

  Retrieves a list of clusters.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves a list of clusters.

  Parameters

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

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
  ): Request<ListClustersRequest, ListClustersResponse>

  Retrieves a list of clusters.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
  ): Request<ListClustersRequest, ListClustersResponse>

  Retrieves a list of clusters.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves a list of clusters.

  Parameters

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

  Returns Request<ListClustersRequest, ListClustersResponse>

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>

start

• start(
      request: StartClusterRequest,
  ): Request<StartClusterRequest, Operation<GetOperationRequest>>

  Starts a cluster.

  Parameters

  • request: StartClusterRequest

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

• start(
      request: StartClusterRequest,
      metadata: Metadata,
  ): Request<StartClusterRequest, Operation<GetOperationRequest>>

  Starts a cluster.

  Parameters

  • request: StartClusterRequest
  • metadata: Metadata

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Starts a cluster.

  Parameters

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

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

• start(
      request: StartClusterRequest,
  ): Request<StartClusterRequest, Operation<GetOperationRequest>>

  Starts a cluster.

  Parameters

  • request: StartClusterRequest

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

• start(
      request: StartClusterRequest,
      metadata: Metadata,
  ): Request<StartClusterRequest, Operation<GetOperationRequest>>

  Starts a cluster.

  Parameters

  • request: StartClusterRequest
  • metadata: Metadata

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Starts a cluster.

  Parameters

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

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

stop

• stop(
      request: StopClusterRequest,
  ): Request<StopClusterRequest, Operation<GetOperationRequest>>

  Stops a cluster.

  Parameters

  • request: StopClusterRequest

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

• stop(
      request: StopClusterRequest,
      metadata: Metadata,
  ): Request<StopClusterRequest, Operation<GetOperationRequest>>

  Stops a cluster.

  Parameters

  • request: StopClusterRequest
  • metadata: Metadata

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Stops a cluster.

  Parameters

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

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

• stop(
      request: StopClusterRequest,
  ): Request<StopClusterRequest, Operation<GetOperationRequest>>

  Stops a cluster.

  Parameters

  • request: StopClusterRequest

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

• stop(
      request: StopClusterRequest,
      metadata: Metadata,
  ): Request<StopClusterRequest, Operation<GetOperationRequest>>

  Stops a cluster.

  Parameters

  • request: StopClusterRequest
  • metadata: Metadata

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Stops a cluster.

  Parameters

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

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>