Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class RestoreServiceRequest.
Request message forDataprocMetastore.Restore.
Generated from protobuf messagegoogle.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 toMETADATA_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 validUUID. 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 toMETADATA_ONLY.
Returns
Type
Description
int
setRestoreType
Optional. The type of restore. If unspecified, defaults toMETADATA_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 validUUID.
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 validUUID.
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 seeDataprocMetastoreClient::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 seeDataprocMetastoreClient::backupName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc Metastore V1 Client - Class RestoreServiceRequest (1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/php/docs/reference/cloud-dataproc-metastore/latest/V1.RestoreServiceRequest)\n- [1.1.0](/php/docs/reference/cloud-dataproc-metastore/1.1.0/V1.RestoreServiceRequest)\n- [1.0.4](/php/docs/reference/cloud-dataproc-metastore/1.0.4/V1.RestoreServiceRequest)\n- [0.11.5](/php/docs/reference/cloud-dataproc-metastore/0.11.5/V1.RestoreServiceRequest)\n- [0.10.2](/php/docs/reference/cloud-dataproc-metastore/0.10.2/V1.RestoreServiceRequest)\n- [0.9.0](/php/docs/reference/cloud-dataproc-metastore/0.9.0/V1.RestoreServiceRequest)\n- [0.8.1](/php/docs/reference/cloud-dataproc-metastore/0.8.1/V1.RestoreServiceRequest)\n- [0.7.0](/php/docs/reference/cloud-dataproc-metastore/0.7.0/V1.RestoreServiceRequest)\n- [0.6.1](/php/docs/reference/cloud-dataproc-metastore/0.6.1/V1.RestoreServiceRequest)\n- [0.5.1](/php/docs/reference/cloud-dataproc-metastore/0.5.1/V1.RestoreServiceRequest)\n- [0.4.1](/php/docs/reference/cloud-dataproc-metastore/0.4.1/V1.RestoreServiceRequest) \nReference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class RestoreServiceRequest.\n\nRequest message for DataprocMetastore.Restore.\n\nGenerated from protobuf message `google.cloud.metastore.v1.RestoreServiceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Metastore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getService\n\nRequired. The relative resource name of the metastore service to run\nrestore, in the following form:\n`projects/{project_id}/locations/{location_id}/services/{service_id}`.\n\n### setService\n\nRequired. The relative resource name of the metastore service to run\nrestore, in the following form:\n`projects/{project_id}/locations/{location_id}/services/{service_id}`.\n\n### getBackup\n\nRequired. The relative resource name of the metastore service backup to\nrestore from, in the following form:\n`projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.\n\n### setBackup\n\nRequired. The relative resource name of the metastore service backup to\nrestore from, in the following form:\n`projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}`.\n\n### getRestoreType\n\nOptional. The type of restore. If unspecified, defaults to `METADATA_ONLY`.\n\n### setRestoreType\n\nOptional. The type of restore. If unspecified, defaults to `METADATA_ONLY`.\n\n### getRequestId\n\nOptional. A request ID. Specify a unique request ID to allow the server to\nignore the request if it has completed. The server will ignore subsequent\nrequests that provide a duplicate request ID for at least 60 minutes after\nthe first request.\n\nFor example, if an initial request times out, followed by another request\nwith the same request ID, the server ignores the second request to prevent\nthe creation of duplicate commitments.\nThe request ID must be a valid\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format).\nA zero UUID (00000000-0000-0000-0000-000000000000) is not supported.\n\n### setRequestId\n\nOptional. A request ID. Specify a unique request ID to allow the server to\nignore the request if it has completed. The server will ignore subsequent\nrequests that provide a duplicate request ID for at least 60 minutes after\nthe first request.\n\nFor example, if an initial request times out, followed by another request\nwith the same request ID, the server ignores the second request to prevent\nthe creation of duplicate commitments.\nThe request ID must be a valid\n[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format).\nA zero UUID (00000000-0000-0000-0000-000000000000) is not supported.\n\n### static::build"]]
