REST Resource: projects.instances.clusters.backups

Resource: Backup

A backup of a Cloud Bigtable table.

JSON representation 
{
  "name": string,
  "sourceTable": string,
  "sourceBackup": string,
  "expireTime": string,
  "startTime": string,
  "endTime": string,
  "sizeBytes": string,
  "state": enum (State),
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "backupType": enum (BackupType),
  "hotToStandardTime": string
}
Fields
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][-_.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}.
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/{sourceTable}.
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/
expireTime

string (Timestamp format)

Required. The expiration time of the backup. When creating a backup or updating its expireTime, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days

Once the expireTime has passed, Cloud Bigtable will delete the backup.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. startTime is the time that the backup was started (i.e. approximately the time the backups.create request is received). The row data in this backup will be no older than this timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. endTime is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
sizeBytes

string (int64 format)

Output only. Size of the backup in bytes.
state

enum (State)

Output only. The current state of the backup.
encryptionInfo

object (EncryptionInfo)

Output only. The encryption information for the backup.
backupType

enum (BackupType)

Indicates the backup type of the backup.
hotToStandardTime

string (Timestamp format)

The time at which the hot backup will be converted to a standard backup. Once the hotToStandardTime 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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

Indicates the current state of the backup.

Enums
STATE_UNSPECIFIED Not specified.
CREATING The pending backup is still being created. Operations on the backup may fail with FAILED_PRECONDITION in this state.
READY The backup is complete and ready for use.

BackupType

The type of the backup.

Enums
BACKUP_TYPE_UNSPECIFIED Not specified.
STANDARD The default type for Cloud Bigtable managed backups. Supported for backups created in both HDD and SSD instances. Requires optimization when restored to a table in an SSD instance.
HOT A backup type with faster restore to SSD performance. Only supported for backups created in SSD instances. A new SSD table restored from a hot backup reaches production performance more quickly than a standard backup.

Methods

copy

 Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

create

 Starts creating a new Cloud Bigtable Backup.

delete

 Deletes a pending or completed Cloud Bigtable backup.

get

 Gets metadata on a pending or completed Cloud Bigtable Backup.

getIamPolicy

 Gets the access control policy for a Bigtable resource.

list

 Lists Cloud Bigtable backups.

patch

 Updates a pending or completed Cloud Bigtable Backup.

setIamPolicy

 Sets the access control policy on a Bigtable resource.

testIamPermissions

 Returns permissions that the caller has on the specified Bigtable resource.