Class BackupService

constructor

• new BackupService(sdk: SDKInterface): BackupService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns BackupService

$type

create

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

  Creates a new on-demand backup.

  Parameters

  • request: CreateBackupRequest

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

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

  Creates a new on-demand backup.

  Parameters

  • request: CreateBackupRequest
  • metadata: Metadata

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

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

  Creates a new on-demand backup.

  Parameters

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

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

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

  Creates a new on-demand backup.

  Parameters

  • request: CreateBackupRequest

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

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

  Creates a new on-demand backup.

  Parameters

  • request: CreateBackupRequest
  • metadata: Metadata

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

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

  Creates a new on-demand backup.

  Parameters

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

  Returns Request<CreateBackupRequest, Operation<GetOperationRequest>>

delete

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

  Deletes an on-demand backup.

  Parameters

  • request: DeleteBackupRequest

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

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

  Deletes an on-demand backup.

  Parameters

  • request: DeleteBackupRequest
  • metadata: Metadata

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

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

  Deletes an on-demand backup.

  Parameters

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

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

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

  Deletes an on-demand backup.

  Parameters

  • request: DeleteBackupRequest

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

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

  Deletes an on-demand backup.

  Parameters

  • request: DeleteBackupRequest
  • metadata: Metadata

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

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

  Deletes an on-demand backup.

  Parameters

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

  Returns Request<DeleteBackupRequest, Operation<GetOperationRequest>>

get

• get(request: GetBackupRequest): Request<GetBackupRequest, Backup>

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

  • request: GetBackupRequest

  Returns Request<GetBackupRequest, Backup>

• get(
      request: GetBackupRequest,
      metadata: Metadata,
  ): Request<GetBackupRequest, Backup>

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

  • request: GetBackupRequest
  • metadata: Metadata

  Returns Request<GetBackupRequest, Backup>

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

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

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

  Returns Request<GetBackupRequest, Backup>

• get(request: GetBackupRequest): Request<GetBackupRequest, Backup>

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

  • request: GetBackupRequest

  Returns Request<GetBackupRequest, Backup>

• get(
      request: GetBackupRequest,
      metadata: Metadata,
  ): Request<GetBackupRequest, Backup>

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

  • request: GetBackupRequest
  • metadata: Metadata

  Returns Request<GetBackupRequest, Backup>

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

  Returns the specified PostgreSQL Cluster backup. To get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.

  Parameters

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

  Returns Request<GetBackupRequest, Backup>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListBackupsRequest,
  ): Request<ListBackupsRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

  • request: ListBackupsRequest

  Returns Request<ListBackupsRequest, ListBackupsResponse>

• list(
      request: ListBackupsRequest,
      metadata: Metadata,
  ): Request<ListBackupsRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

  • request: ListBackupsRequest
  • metadata: Metadata

  Returns Request<ListBackupsRequest, ListBackupsResponse>

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

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

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

  Returns Request<ListBackupsRequest, ListBackupsResponse>

• list(
      request: ListBackupsRequest,
  ): Request<ListBackupsRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

  • request: ListBackupsRequest

  Returns Request<ListBackupsRequest, ListBackupsResponse>

• list(
      request: ListBackupsRequest,
      metadata: Metadata,
  ): Request<ListBackupsRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

  • request: ListBackupsRequest
  • metadata: Metadata

  Returns Request<ListBackupsRequest, ListBackupsResponse>

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

  Retrieves the list of PostgreSQL Cluster backups by project.

  Parameters

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

  Returns Request<ListBackupsRequest, ListBackupsResponse>

listByCluster

• listByCluster(
      request: ListBackupsByClusterRequest,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

  • request: ListBackupsByClusterRequest

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>

• listByCluster(
      request: ListBackupsByClusterRequest,
      metadata: Metadata,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

  • request: ListBackupsByClusterRequest
  • metadata: Metadata

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>

• listByCluster(
      request: ListBackupsByClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

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

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>

• listByCluster(
      request: ListBackupsByClusterRequest,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

  • request: ListBackupsByClusterRequest

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>

• listByCluster(
      request: ListBackupsByClusterRequest,
      metadata: Metadata,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

  • request: ListBackupsByClusterRequest
  • metadata: Metadata

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>

• listByCluster(
      request: ListBackupsByClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListBackupsByClusterRequest, ListBackupsResponse>

  Retrieves the list of PostgreSQL Cluster backups by cluster.

  Parameters

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

  Returns Request<ListBackupsByClusterRequest, ListBackupsResponse>