Cloud Bigtable V2 Client - Class CreateBackupRequest (2.8.0)

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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

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_idstring

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]*.

↳ backupBackup

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
TypeDescription
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
NameDescription
varstring
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
varstring
Returns
TypeDescription
$this

getBackup

Required. The backup to create.

Returns
TypeDescription
Backup|null

hasBackup

clearBackup

setBackup

Required. The backup to create.

Parameter
NameDescription
varBackup
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

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 BigtableTableAdminClient::clusterName() for help formatting this field.

backupIdstring

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]*.

backupBackup

Required. The backup to create.

Returns
TypeDescription
CreateBackupRequest