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 |
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 |
↳ 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 |
↳ expire_time |
Google\Protobuf\Timestamp
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 |
↳ start_time |
Google\Protobuf\Timestamp
Output only. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. |
↳ size_bytes |
int|string
Output only. Size of the backup in bytes. |
↳ state |
int
Output only. The current state of the backup. |
↳ encryption_info |
Google\Cloud\Bigtable\Admin\V2\EncryptionInfo
Output only. The encryption information for the backup. |
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 | |
getExpireTime
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 expire_time
has passed, Cloud Bigtable will delete the backup and free the
resources used by the backup.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasExpireTime
clearExpireTime
setExpireTime
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 expire_time
has passed, Cloud Bigtable will delete the backup and free the
resources used by 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 |
Google\Cloud\Bigtable\Admin\V2\EncryptionInfo|null | |
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. The encryption information for the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\EncryptionInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |