Cloud Bigtable V2 Client - Class CreateBackupRequest (1.25.0)

Version 1.25.0

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

Reference documentation and code samples for the Cloud Bigtable V2 Client class CreateBackupRequest.

The request for CreateBackup.

Generated from protobuf message google.bigtable.admin.v2.CreateBackupRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
↳ backup_id	string Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
↳ backup	Google\Cloud\Bigtable\Admin\V2\Backup Required. The backup to create.

getParent

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns
Type	Description
string

setParent

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBackupId

Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}.

This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.

Returns
Type	Description
string

setBackupId

Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}.

This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBackup

Required. The backup to create.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Backup|null

hasBackup

clearBackup

setBackup

Required. The backup to create.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\Backup

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::clusterName() for help formatting this field.
backupId	string Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex [a-zA-Z0-9][-.a-zA-Z0-9]*.
backup	Google\Cloud\Bigtable\Admin\V2\Backup Required. The backup to create.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\CreateBackupRequest