Google Cloud Dataproc Metastore V1 Client - Class RestoreServiceRequest (0.11.3)

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

Request message for DataprocMetastore.Restore.

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

Namespace

Google \ Cloud \ Metastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The relative resource name of the metastore service to run restore, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}.
↳ backup string

Required. The relative resource name of the metastore service backup to restore from, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
↳ restore_type int

Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.
↳ 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.

getService

Required. The relative resource name of the metastore service to run restore, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}.

Returns
Type Description
string

setService

Required. The relative resource name of the metastore service to run restore, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getBackup

Required. The relative resource name of the metastore service backup to restore from, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
Type Description
string

setBackup

Required. The relative resource name of the metastore service backup to restore from, in the following form: projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getRestoreType

Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.

Returns
Type Description
int

setRestoreType

Optional. The type of restore. If unspecified, defaults to METADATA_ONLY.

Parameter
Name Description
var int
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
service string

Required. The relative resource name of the metastore service to run restore, in the following form:

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

Required. The relative resource name of the metastore service backup to restore from, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Please see Google\Cloud\Metastore\V1\DataprocMetastoreClient::backupName() for help formatting this field.
Returns
Type Description
Google\Cloud\Metastore\V1\RestoreServiceRequest