| <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.autoProtectionPolicies.html">autoProtectionPolicies</a> . <a href="backupdr_v1.projects.locations.autoProtectionPolicies.bindings.html">bindings</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="backupdr_v1.projects.locations.autoProtectionPolicies.bindings.matchingResources.html">matchingResources()</a></code> | |
| </p> | |
| <p class="firstline">Returns the matchingResources 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, autoProtectionPolicyBindingId=None, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a new AutoProtectionPolicyBinding in a given project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns the auto protection policy binding read from the CCFE tables.</p> | |
| <p class="toc_element"> | |
| <code><a href="#initiateDelete">initiateDelete(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Initiates delete for AutoProtectionPolicy Binding</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">Returns the auto protection policy bindings read from the CCFE tables.</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> | |
| <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, autoProtectionPolicyBindingId=None, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Creates a new AutoProtectionPolicyBinding in a given project and location. | |
| Args: | |
| parent: string, Required. The parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # An AutoProtectionPolicyBinding (APPA) acts as the bridge between an AutoProtectionPolicy and the scope (Project) where the policy should be applied. | |
| "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy. | |
| "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run. | |
| "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria. | |
| "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected. | |
| }, | |
| "createTime": "A String", # Output only. The timestamp when the binding was created. | |
| "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. | |
| "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. | |
| "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` | |
| "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} | |
| "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. | |
| "updateTime": "A String", # Output only. The timestamp when the binding was last updated. | |
| } | |
| autoProtectionPolicyBindingId: string, Required. The ID to use for the binding. This will become the final component of the binding's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. | |
| 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 server will guarantee that for at least 60 minutes since the first request. 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>Returns the auto protection policy binding read from the CCFE tables. | |
| Args: | |
| name: string, Required. The name of the binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding} (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An AutoProtectionPolicyBinding (APPA) acts as the bridge between an AutoProtectionPolicy and the scope (Project) where the policy should be applied. | |
| "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy. | |
| "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run. | |
| "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria. | |
| "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected. | |
| }, | |
| "createTime": "A String", # Output only. The timestamp when the binding was created. | |
| "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. | |
| "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. | |
| "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` | |
| "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} | |
| "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. | |
| "updateTime": "A String", # Output only. The timestamp when the binding was last updated. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="initiateDelete">initiateDelete(name, body=None, x__xgafv=None)</code> | |
| <pre>Initiates delete for AutoProtectionPolicy Binding | |
| Args: | |
| name: string, Required. The name of the binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding} (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request message for initiating delete of an AutoProtectionPolicyBinding. | |
| "etag": "A String", # Optional. The current etag of the AutoProtectionPolicyBinding. If an etag is provided and does not match the current etag of the binding, deletion will be blocked and an ABORTED error will be returned. | |
| "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 server will guarantee that for at least 60 minutes since the first request. 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="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Returns the auto protection policy bindings read from the CCFE tables. | |
| Args: | |
| parent: string, Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location} (required) | |
| filter: string, Optional. A filter expression that filters resources listed in the response. The following fields are filterable: | |
| orderBy: string, Optional. An expression that sorts the results in the response. The following fields are sortable: | |
| pageSize: integer, Optional. The maximum number of policies to return in a single page is 500. If unspecified, a server-default value will be used. | |
| pageToken: string, Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page. | |
| 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 ListAutoProtectionPolicyBindings. | |
| "autoProtectionPolicyBindings": [ # A list of the AutoProtectionPolicyBindings resources found. | |
| { # An AutoProtectionPolicyBinding (APPA) acts as the bridge between an AutoProtectionPolicy and the scope (Project) where the policy should be applied. | |
| "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy. | |
| "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run. | |
| "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria. | |
| "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected. | |
| }, | |
| "createTime": "A String", # Output only. The timestamp when the binding was created. | |
| "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. | |
| "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. | |
| "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` | |
| "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} | |
| "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. | |
| "updateTime": "A String", # Output only. The timestamp when the binding was last updated. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | |
| "unreachable": [ # Unordered list. 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> | |
| </body></html> |