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.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringA globally unique identifier for the backup which cannot be changed. Values are of the form |
↳ source_table | stringRequired. 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 |
↳ source_backup | stringOutput 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\TimestampRequired. The expiration time of the backup. When creating a backup or updating its |
↳ start_time | Google\Protobuf\TimestampOutput only. |
↳ end_time | Google\Protobuf\TimestampOutput only. |
↳ size_bytes | int|stringOutput only. Size of the backup in bytes. |
↳ state | intOutput only. The current state of the backup. |
↳ encryption_info | EncryptionInfoOutput only. The encryption information for the backup. |
↳ backup_type | intIndicates the backup type of the backup. |
↳ hot_to_standard_time | Google\Protobuf\TimestampThe time at which the hot backup will be converted to a standard backup. Once the |
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}.
| Returns | |
|---|---|
| Type | Description |
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}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$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}.
| Returns | |
|---|---|
| Type | Description |
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}.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$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/
| Returns | |
|---|---|
| Type | Description |
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/
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSizeBytes
Output only. Size of the backup in bytes.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSizeBytes
Output only. Size of the backup in bytes.
| Parameter | |
|---|---|
| Name | Description |
var | int|string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the backup.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the backup.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionInfo
Output only. The encryption information for the backup.
| Returns | |
|---|---|
| Type | Description |
EncryptionInfo|null | |
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. The encryption information for the backup.
| Parameter | |
|---|---|
| Name | Description |
var | EncryptionInfo |
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackupType
Indicates the backup type of the backup.
| Returns | |
|---|---|
| Type | Description |
int | |
setBackupType
Indicates the backup type of the backup.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Timestamp |
| Returns | |
|---|---|
| Type | Description |
$this | |