Reference documentation and code samples for the Cloud Bigtable V2 Client class Backup.
A backup of a Cloud Bigtable table.
Generated from protobuf message google.bigtable.admin.v2.Backup
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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}
.
↳ source_table
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}
.
↳ source_backup
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/
↳ expire_time
Google\Protobuf\Timestamp
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.
↳ start_time
Google\Protobuf\Timestamp
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.
↳ end_time
Google\Protobuf\Timestamp
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.
↳ size_bytes
int|string
Output only. Size of the backup in bytes.
↳ state
int
Output only. The current state of the backup.
↳ encryption_info
↳ backup_type
int
Indicates the backup type of the backup.
↳ hot_to_standard_time
Google\Protobuf\Timestamp
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.
getName
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}
.
string
setName
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}
.
var
string
$this
getSourceTable
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}
.
string
setSourceTable
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}
.
var
string
$this
getSourceBackup
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/
string
setSourceBackup
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/
var
string
$this
getExpireTime
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_timehas passed, Cloud Bigtable will delete the backup.
hasExpireTime
clearExpireTime
setExpireTime
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_timehas passed, Cloud Bigtable will delete the backup.
$this
getStartTime
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.
hasStartTime
clearStartTime
setStartTime
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.
$this
getEndTime
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.
hasEndTime
clearEndTime
setEndTime
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.
$this
getSizeBytes
Output only. Size of the backup in bytes.
int|string
setSizeBytes
Output only. Size of the backup in bytes.
var
int|string
$this
getState
Output only. The current state of the backup.
int
setState
Output only. The current state of the backup.
var
int
$this
getEncryptionInfo
Output only. The encryption information for the backup.
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. The encryption information for the backup.
$this
getBackupType
Indicates the backup type of the backup.
int
setBackupType
Indicates the backup type of the backup.
var
int
$this
getHotToStandardTime
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.
hasHotToStandardTime
clearHotToStandardTime
setHotToStandardTime
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.
$this
