| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="backupdr_v1.html">Backup and DR Service API</a> . <a href="backupdr_v1.projects.html">projects</a> . <a href="backupdr_v1.projects.locations.html">locations</a> . <a href="backupdr_v1.projects.locations.restoreTemplates.html">restoreTemplates</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="backupdr_v1.projects.locations.restoreTemplates.executions.html">executions()</a></code> | |
| </p> | |
| <p class="firstline">Returns the executions Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, body=None, requestId=None, restoreTemplateId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a new RestoreTemplate in a given project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a RestoreTemplate.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets details of a RestoreTemplate.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists RestoreTemplates in a given project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates the settings of a RestoreTemplate.</p> | |
| <p class="toc_element"> | |
| <code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Runs a RestoreTemplate.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, body=None, requestId=None, restoreTemplateId=None, x__xgafv=None)</code> | |
| <pre>Creates a new RestoreTemplate in a given project and location. | |
| Args: | |
| parent: string, Required. The restore template project and location in the format 'projects/{project_id}/locations/{location}'. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # A `RestoreTemplate` encapsulates DR readiness configurations for validating backups. | |
| "backupSelectionConfig": { # Configuration for selecting a backup. # Required. Backup selection configuration. | |
| "dataSource": "A String", # Required. Immutable. The fully qualified URI of the backupdr data source. | |
| }, | |
| "createTime": "A String", # Output only. The time when the restore template was created. | |
| "description": "A String", # Optional. User-provided description of the restore template. | |
| "etag": "A String", # Optional. Etag for concurrency control. | |
| "executionSummary": { # Summary of the last execution. # Output only. Summary of the last execution. | |
| "lastExecution": "A String", # Output only. The resource name of the last execution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}` | |
| "lastExecutionState": "A String", # Output only. The state of the last execution. | |
| }, | |
| "labels": { # Optional. User-defined labels. | |
| "a_key": "A String", | |
| }, | |
| "name": "A String", # Identifier. The resource name of the RestoreTemplate. | |
| "postRestoreConfig": { # Configuration for Post-Restore. # Optional. Post-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "preRestoreConfig": { # Configuration for Pre-Restore. # Optional. Pre-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "resourceType": "A String", # Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance". | |
| "restoreProperties": { # 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"`). | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "state": "A String", # Output only. The state of the restore template. | |
| "updateTime": "A String", # Output only. The time when the restore template was last updated. | |
| "verificationConfig": { # Configuration for Verification. # Optional. Verification configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| } | |
| requestId: string, 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). | |
| restoreTemplateId: string, Required. The ID of the restore template to create. The ID must be unique for the specified project and location. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # 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. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # 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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # 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}`. | |
| "response": { # 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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Deletes a RestoreTemplate. | |
| Args: | |
| name: string, Required. The name of the restore template to delete. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}' (required) | |
| force: boolean, Optional. If set to true, any child RestoreTemplateExecutions will also be deleted. If false and the RestoreTemplate has any child executions, the request will fail. | |
| requestId: string, 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). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # 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. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # 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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # 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}`. | |
| "response": { # 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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets details of a RestoreTemplate. | |
| Args: | |
| name: string, Required. The name of the restore template to retrieve. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}' (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A `RestoreTemplate` encapsulates DR readiness configurations for validating backups. | |
| "backupSelectionConfig": { # Configuration for selecting a backup. # Required. Backup selection configuration. | |
| "dataSource": "A String", # Required. Immutable. The fully qualified URI of the backupdr data source. | |
| }, | |
| "createTime": "A String", # Output only. The time when the restore template was created. | |
| "description": "A String", # Optional. User-provided description of the restore template. | |
| "etag": "A String", # Optional. Etag for concurrency control. | |
| "executionSummary": { # Summary of the last execution. # Output only. Summary of the last execution. | |
| "lastExecution": "A String", # Output only. The resource name of the last execution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}` | |
| "lastExecutionState": "A String", # Output only. The state of the last execution. | |
| }, | |
| "labels": { # Optional. User-defined labels. | |
| "a_key": "A String", | |
| }, | |
| "name": "A String", # Identifier. The resource name of the RestoreTemplate. | |
| "postRestoreConfig": { # Configuration for Post-Restore. # Optional. Post-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "preRestoreConfig": { # Configuration for Pre-Restore. # Optional. Pre-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "resourceType": "A String", # Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance". | |
| "restoreProperties": { # 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"`). | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "state": "A String", # Output only. The state of the restore template. | |
| "updateTime": "A String", # Output only. The time when the restore template was last updated. | |
| "verificationConfig": { # Configuration for Verification. # Optional. Verification configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists RestoreTemplates in a given project and location. | |
| Args: | |
| parent: string, Required. The project and location from which to list the restore templates. Format: `projects/{project}/locations/{location}`. (required) | |
| filter: string, Optional. Field match expression used to filter the results. | |
| orderBy: string, Optional. Field by which to sort the results. | |
| pageSize: integer, Optional. The maximum number of items to return. | |
| pageToken: string, Optional. A page token, received from a previous `ListRestoreTemplates` call. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for listing RestoreTemplates. | |
| "nextPageToken": "A String", # A token which may be sent as `page_token` in a subsequent `ListRestoreTemplates` call. | |
| "restoreTemplates": [ # The list of RestoreTemplates. | |
| { # A `RestoreTemplate` encapsulates DR readiness configurations for validating backups. | |
| "backupSelectionConfig": { # Configuration for selecting a backup. # Required. Backup selection configuration. | |
| "dataSource": "A String", # Required. Immutable. The fully qualified URI of the backupdr data source. | |
| }, | |
| "createTime": "A String", # Output only. The time when the restore template was created. | |
| "description": "A String", # Optional. User-provided description of the restore template. | |
| "etag": "A String", # Optional. Etag for concurrency control. | |
| "executionSummary": { # Summary of the last execution. # Output only. Summary of the last execution. | |
| "lastExecution": "A String", # Output only. The resource name of the last execution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}` | |
| "lastExecutionState": "A String", # Output only. The state of the last execution. | |
| }, | |
| "labels": { # Optional. User-defined labels. | |
| "a_key": "A String", | |
| }, | |
| "name": "A String", # Identifier. The resource name of the RestoreTemplate. | |
| "postRestoreConfig": { # Configuration for Post-Restore. # Optional. Post-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "preRestoreConfig": { # Configuration for Pre-Restore. # Optional. Pre-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "resourceType": "A String", # Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance". | |
| "restoreProperties": { # 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"`). | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "state": "A String", # Output only. The state of the restore template. | |
| "updateTime": "A String", # Output only. The time when the restore template was last updated. | |
| "verificationConfig": { # Configuration for Verification. # Optional. Verification configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| }, | |
| ], | |
| "unreachable": [ # Locations that could not be reached. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code> | |
| <pre>Updates the settings of a RestoreTemplate. | |
| Args: | |
| name: string, Identifier. The resource name of the RestoreTemplate. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # A `RestoreTemplate` encapsulates DR readiness configurations for validating backups. | |
| "backupSelectionConfig": { # Configuration for selecting a backup. # Required. Backup selection configuration. | |
| "dataSource": "A String", # Required. Immutable. The fully qualified URI of the backupdr data source. | |
| }, | |
| "createTime": "A String", # Output only. The time when the restore template was created. | |
| "description": "A String", # Optional. User-provided description of the restore template. | |
| "etag": "A String", # Optional. Etag for concurrency control. | |
| "executionSummary": { # Summary of the last execution. # Output only. Summary of the last execution. | |
| "lastExecution": "A String", # Output only. The resource name of the last execution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}` | |
| "lastExecutionState": "A String", # Output only. The state of the last execution. | |
| }, | |
| "labels": { # Optional. User-defined labels. | |
| "a_key": "A String", | |
| }, | |
| "name": "A String", # Identifier. The resource name of the RestoreTemplate. | |
| "postRestoreConfig": { # Configuration for Post-Restore. # Optional. Post-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "preRestoreConfig": { # Configuration for Pre-Restore. # Optional. Pre-restore configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| "resourceType": "A String", # Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance". | |
| "restoreProperties": { # 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"`). | |
| "a_key": "", # Properties of the object. | |
| }, | |
| "state": "A String", # Output only. The state of the restore template. | |
| "updateTime": "A String", # Output only. The time when the restore template was last updated. | |
| "verificationConfig": { # Configuration for Verification. # Optional. Verification configuration. | |
| "cloudRunJob": "A String", # Cloud Run job action to execute. Format: `projects/{project}/locations/{location}/jobs/{job}` | |
| "timeout": "A String", # Optional. The `timeout` for this phase. If set, the `timeout` must be positive and less than or equal to 24 hours (86400s). | |
| }, | |
| } | |
| requestId: string, 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). | |
| updateMask: string, 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. | |
| validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # 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. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # 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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # 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}`. | |
| "response": { # 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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="run">run(name, body=None, x__xgafv=None)</code> | |
| <pre>Runs a RestoreTemplate. | |
| Args: | |
| name: string, Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}' (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request message for running a RestoreTemplate. | |
| "backup": "A String", # Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}' | |
| "requestId": "A String", # 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). | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # 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. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # 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. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # 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}`. | |
| "response": { # 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`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |