GOgoogle
projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}

Changed on

Updates the settings of a RestoreTemplate.

Request

  • Base URL
    https://backupdr.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-backupdr
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-backupdr
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
restoreTemplatesIdstring required

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMaskstring google-fieldmask

Optional. The list of fields to update. Field mask is used to specify the fields to be overwritten in the RestoreTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is 'false'.

Request body

createTimestring google-datetime

Output only. The time when the restore template was created.

descriptionstring

Optional. User-provided description of the restore template.

etagstring

Optional. Etag for concurrency control.

labelsobject

Optional. User-defined labels.

namestring

Identifier. The resource name of the RestoreTemplate.

resourceTypestring

Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

restorePropertiesobject

Required. Defines target environments where the resource will be restored. The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING'

Output only. The state of the restore template.

updateTimestring google-datetime

Output only. The time when the restore template was last updated.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes