Backup and DR Service API . projects . locations . autoProtectionPolicies . bindings

Instance Methods

matchingResources()

Returns the matchingResources Resource.

close()

Close httplib2 connections.

create(parent, autoProtectionPolicyBindingId=None, body=None, x__xgafv=None)

Creates a new AutoProtectionPolicyBinding in a given project and location.

get(name, x__xgafv=None)

Returns the auto protection policy binding read from the CCFE tables.

initiateDelete(name, body=None, x__xgafv=None)

InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Returns the auto protection policy bindings read from the CCFE tables.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, autoProtectionPolicyBindingId=None, body=None, x__xgafv=None)
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, Folder, or Organization) 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.
  "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", # 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.
  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.
  },
}
get(name, x__xgafv=None)
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, Folder, or Organization) 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.
  "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", # 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.
}
initiateDelete(name, body=None, x__xgafv=None)
InitiateDeleteAutoProtectionPolicyBinding 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.
}

  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.
  },
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
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. 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, Folder, or Organization) 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.
      "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", # 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",
  ],
}
list_next(previous_request, previous_response)
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.