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 PostgreSQL cluster in the specified folder.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a PostgreSQL cluster in the specified folder.

  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 PostgreSQL cluster in the specified folder.

  Parameters

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

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a PostgreSQL cluster in the specified folder.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

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

  Creates a PostgreSQL cluster in the specified folder.

  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 PostgreSQL cluster in the specified folder.

  Parameters

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

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

delete

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

  Deletes the specified PostgreSQL cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Deletes the specified PostgreSQL cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Deletes the specified PostgreSQL cluster.

  Parameters

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

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Deletes the specified PostgreSQL cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Deletes the specified PostgreSQL cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

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

  Deletes the specified PostgreSQL cluster.

  Parameters

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

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

get

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

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

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

  Parameters

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

  Returns Request<GetClusterRequest, Cluster>

getByName

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

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

  Returns Request<GetByNameRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource by name.

  Parameters

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

  Returns Request<GetByNameRequest, Cluster>

getForBackup

• getForBackup(
      request: GetClusterForBackupRequest,
  ): Request<GetClusterForBackupRequest, Cluster>

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

  • request: GetClusterForBackupRequest

  Returns Request<GetClusterForBackupRequest, Cluster>

• getForBackup(
      request: GetClusterForBackupRequest,
      metadata: Metadata,
  ): Request<GetClusterForBackupRequest, Cluster>

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

  • request: GetClusterForBackupRequest
  • metadata: Metadata

  Returns Request<GetClusterForBackupRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

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

  Returns Request<GetClusterForBackupRequest, Cluster>

• getForBackup(
      request: GetClusterForBackupRequest,
  ): Request<GetClusterForBackupRequest, Cluster>

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

  • request: GetClusterForBackupRequest

  Returns Request<GetClusterForBackupRequest, Cluster>

• getForBackup(
      request: GetClusterForBackupRequest,
      metadata: Metadata,
  ): Request<GetClusterForBackupRequest, Cluster>

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

  • request: GetClusterForBackupRequest
  • metadata: Metadata

  Returns Request<GetClusterForBackupRequest, Cluster>

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

  Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

  Parameters

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

  Returns Request<GetClusterForBackupRequest, Cluster>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

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

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

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

  Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

  Parameters

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

  Returns Request<ListClustersRequest, ListClustersResponse>

restore

• restore(
      request: RestoreClusterRequest,
  ): Request<RestoreClusterRequest, Operation<GetOperationRequest>>

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

  • request: RestoreClusterRequest

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

• restore(
      request: RestoreClusterRequest,
      metadata: Metadata,
  ): Request<RestoreClusterRequest, Operation<GetOperationRequest>>

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

  • request: RestoreClusterRequest
  • metadata: Metadata

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

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

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

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

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

• restore(
      request: RestoreClusterRequest,
  ): Request<RestoreClusterRequest, Operation<GetOperationRequest>>

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

  • request: RestoreClusterRequest

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

• restore(
      request: RestoreClusterRequest,
      metadata: Metadata,
  ): Request<RestoreClusterRequest, Operation<GetOperationRequest>>

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

  • request: RestoreClusterRequest
  • metadata: Metadata

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

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

  Creates a new PostgreSQL cluster from a previously created backup.

  Parameters

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

  Returns Request<RestoreClusterRequest, Operation<GetOperationRequest>>

start

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

  • request: StartClusterRequest

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

  • request: StartClusterRequest
  • metadata: Metadata

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

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

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

  • request: StartClusterRequest

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

  • request: StartClusterRequest
  • metadata: Metadata

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

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

  Wakes up suspended PostgreSQL cluster.

  Parameters

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

  Returns Request<StartClusterRequest, Operation<GetOperationRequest>>

stop

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

  • request: StopClusterRequest

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

  • request: StopClusterRequest
  • metadata: Metadata

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

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

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

  • request: StopClusterRequest

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

  • request: StopClusterRequest
  • metadata: Metadata

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

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

  Suspends the PostgreSQL cluster to save resources.

  Parameters

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

  Returns Request<StopClusterRequest, Operation<GetOperationRequest>>

update

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

  Updates the PostgreSQL cluster.

  Parameters

  • request: UpdateClusterRequest

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

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

  Updates the PostgreSQL cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

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

  Updates the PostgreSQL cluster.

  Parameters

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

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

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

  Updates the PostgreSQL cluster.

  Parameters

  • request: UpdateClusterRequest

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

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

  Updates the PostgreSQL cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

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

  Updates the PostgreSQL cluster.

  Parameters

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

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>