REST Resource: projects.instances.clusters.backups

Resource: Backup

A backup of a Cloud Bigtable table.

JSON representation
{
  "name": string,
  "sourceTable": string,
  "expireTime": string,
  "startTime": string,
  "endTime": string,
  "sizeBytes": string,
  "state": enum (State)
}
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}.

expireTime

string (Timestamp format)

Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expireTime has passed, Cloud Bigtable will delete the backup and free the resources used by 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.

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.

Methods

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 Table resource.

list

Lists Cloud Bigtable backups.

patch

Updates a pending or completed Cloud Bigtable Backup.

setIamPolicy

Sets the access control policy on a Table resource.

testIamPermissions

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