backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	google.bigtableadmin.backups

Fields

Name	Datatype	Description
name	string	A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.
backupType	string	Indicates the backup type of the backup.
encryptionInfo	object	Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
endTime	string	Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
expireTime	string	Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the expire_time has passed, Cloud Bigtable will delete the backup.
hotToStandardTime	string	The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
sizeBytes	string	Output only. Size of the backup in bytes.
sourceBackup	string	Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/
sourceTable	string	Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.
startTime	string	Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
state	string	Output only. The current state of the backup.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	backupsId, clustersId, instancesId, projectsId	Gets metadata on a pending or completed Cloud Bigtable Backup.
list	SELECT	clustersId, instancesId, projectsId	Lists Cloud Bigtable backups. Returns both completed and pending backups.
create	INSERT	clustersId, instancesId, projectsId	Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
delete	DELETE	backupsId, clustersId, instancesId, projectsId	Deletes a pending or completed Cloud Bigtable backup.
patch	UPDATE	backupsId, clustersId, instancesId, projectsId	Updates a pending or completed Cloud Bigtable Backup.
copy	EXEC	clustersId, instancesId, projectsId	Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

SELECT examples

Lists Cloud Bigtable backups. Returns both completed and pending backups.

SELECT
name,
backupType,
encryptionInfo,
endTime,
expireTime,
hotToStandardTime,
sizeBytes,
sourceBackup,
sourceTable,
startTime,
state
FROM google.bigtableadmin.backups
WHERE clustersId = '{{ clustersId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new backups resource.

All Properties

/*+ create */
INSERT INTO google.bigtableadmin.backups (
clustersId,
instancesId,
projectsId,
name,
sourceTable,
expireTime,
backupType,
hotToStandardTime
)
SELECT 
'{{ clustersId }}',
'{{ instancesId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ sourceTable }}',
'{{ expireTime }}',
'{{ backupType }}',
'{{ hotToStandardTime }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: sourceTable
      value: string
    - name: sourceBackup
      value: string
    - name: expireTime
      value: string
    - name: startTime
      value: string
    - name: endTime
      value: string
    - name: sizeBytes
      value: string
    - name: state
      value: string
    - name: encryptionInfo
      value:
        - name: encryptionType
          value: string
        - name: encryptionStatus
          value:
            - name: code
              value: integer
            - name: message
              value: string
            - name: details
              value:
                - object
        - name: kmsKeyVersion
          value: string
    - name: backupType
      value: string
    - name: hotToStandardTime
      value: string

UPDATE example

Updates a backups resource.

/*+ update */
UPDATE google.bigtableadmin.backups
SET 
name = '{{ name }}',
sourceTable = '{{ sourceTable }}',
expireTime = '{{ expireTime }}',
backupType = '{{ backupType }}',
hotToStandardTime = '{{ hotToStandardTime }}'
WHERE 
backupsId = '{{ backupsId }}'
AND clustersId = '{{ clustersId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified backups resource.

/*+ delete */
DELETE FROM google.bigtableadmin.backups
WHERE backupsId = '{{ backupsId }}'
AND clustersId = '{{ clustersId }}'
AND instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';