Google Cloud Dataproc Metastore V1 Client - Class CreateBackupRequest (1.0.0)

Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class CreateBackupRequest.

Request message for DataprocMetastore.CreateBackup.

Generated from protobuf message google.cloud.metastore.v1.CreateBackupRequest

Namespace

Google \ Cloud \ Metastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The relative resource name of the service in which to create a backup of the following form: projects/{project_number}/locations/{location_id}/services/{service_id}.
↳ backup_id string

Required. The ID of the backup, which is used as the final component of the backup's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
↳ backup Google\Cloud\Metastore\V1\Backup

Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request's backup_id field.
↳ request_id string

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

getParent

Required. The relative resource name of the service in which to create a backup of the following form: projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns
Type Description
string

setParent

Required. The relative resource name of the service in which to create a backup of the following form: projects/{project_number}/locations/{location_id}/services/{service_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getBackupId

Required. The ID of the backup, which is used as the final component of the backup's name.

This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

Returns
Type Description
string

setBackupId

Required. The ID of the backup, which is used as the final component of the backup's name.

This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

Parameter
Name Description
var string
Returns
Type Description
$this

getBackup

Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request's backup_id field.

Returns
Type Description
Google\Cloud\Metastore\V1\Backup|null

hasBackup

clearBackup

setBackup

Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request's backup_id field.

Parameter
Name Description
var Google\Cloud\Metastore\V1\Backup
Returns
Type Description
$this

getRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Returns
Type Description
string

setRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The relative resource name of the service in which to create a backup of the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}. Please see Google\Cloud\Metastore\V1\DataprocMetastoreClient::serviceName() for help formatting this field.
backup Google\Cloud\Metastore\V1\Backup

Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request's backup_id field.
backupId string

Required. The ID of the backup, which is used as the final component of the backup's name.

This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
Returns
Type Description
Google\Cloud\Metastore\V1\CreateBackupRequest