Backup and DR Service API . projects . locations . restoreVerificationPlans . associations

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, requestId=None, restoreVerificationPlanAssociationId=None, x__xgafv=None)

Creates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

delete(name, requestId=None, x__xgafv=None)

Deletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

get(name, x__xgafv=None)

Gets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

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

Lists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Triggers a new Restore Verification for the association in a given RestoreVerificationPlan.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, requestId=None, restoreVerificationPlanAssociationId=None, x__xgafv=None)
Creates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

Args:
  parent: string, Required. The parent resource where this association will be created. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A `RestoreVerificationPlanAssociation` binds a specific workload to a `RestoreVerificationPlan`.
  "createTime": "A String", # Output only. The time when the association was created.
  "description": "A String", # Optional. The description of the `RestoreVerificationPlanAssociation` resource.
  "labels": { # Optional. User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}
  "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`).
  "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger.
  "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`.
  "triggerSummary": { # `TriggerSummary` contains the results of the most recent automated restore initiation and the next scheduled execution time. # Output only. Results of the most recent automated restore initiation and the next scheduled execution time.
    "lastTriggerError": { # 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). # Output only. The error status of the most recent failed trigger.
      "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.
    },
    "lastTriggerTime": "A String", # Output only. The time of the most recent trigger initiation.
    "lastVerificationExecution": "A String", # Output only. The resource name of the most recent initiated RestoreTemplateExecution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}`
    "nextTriggerTime": "A String", # Output only. The scheduled time of the next trigger initiation.
  },
  "updateTime": "A String", # Output only. The time when the association was updated.
}

  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 that the server has already received the duplicate request and can avoid responding with an error. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  restoreVerificationPlanAssociationId: string, Required. The ID to use for the association, which will become the final component of the association's resource name. This value should be 1-63 characters, and valid characters are /[a-z0-9_-]/.
  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.
  },
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

Args:
  name: string, Required. The resource name of the RestoreVerificationPlanAssociation to delete. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` (required)
  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 that the server has already received the duplicate request and can avoid responding with an error. 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.
  },
}
get(name, x__xgafv=None)
Gets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.

Args:
  name: string, Required. The resource name of the RestoreVerificationPlanAssociation to retrieve. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A `RestoreVerificationPlanAssociation` binds a specific workload to a `RestoreVerificationPlan`.
  "createTime": "A String", # Output only. The time when the association was created.
  "description": "A String", # Optional. The description of the `RestoreVerificationPlanAssociation` resource.
  "labels": { # Optional. User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}
  "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`).
  "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger.
  "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`.
  "triggerSummary": { # `TriggerSummary` contains the results of the most recent automated restore initiation and the next scheduled execution time. # Output only. Results of the most recent automated restore initiation and the next scheduled execution time.
    "lastTriggerError": { # 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). # Output only. The error status of the most recent failed trigger.
      "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.
    },
    "lastTriggerTime": "A String", # Output only. The time of the most recent trigger initiation.
    "lastVerificationExecution": "A String", # Output only. The resource name of the most recent initiated RestoreTemplateExecution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}`
    "nextTriggerTime": "A String", # Output only. The scheduled time of the next trigger initiation.
  },
  "updateTime": "A String", # Output only. The time when the association was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan.

Args:
  parent: string, Required. The parent RestoreVerificationPlan name. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}` (required)
  filter: string, Optional. Filtering results.
  orderBy: string, Optional. Hint for how to order the results.
  pageSize: integer, Optional. The maximum number of associations to return. The service may return fewer than this value. If unspecified, at most 500 associations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListRestoreVerificationPlanAssociations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRestoreVerificationPlanAssociations` must match the call that provided the page token.
  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 ListRestoreVerificationPlanAssociations.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "restoreVerificationPlanAssociations": [ # The list of RestoreVerificationPlanAssociations.
    { # A `RestoreVerificationPlanAssociation` binds a specific workload to a `RestoreVerificationPlan`.
      "createTime": "A String", # Output only. The time when the association was created.
      "description": "A String", # Optional. The description of the `RestoreVerificationPlanAssociation` resource.
      "labels": { # Optional. User-defined labels.
        "a_key": "A String",
      },
      "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}
      "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`).
      "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger.
      "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`.
      "triggerSummary": { # `TriggerSummary` contains the results of the most recent automated restore initiation and the next scheduled execution time. # Output only. Results of the most recent automated restore initiation and the next scheduled execution time.
        "lastTriggerError": { # 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). # Output only. The error status of the most recent failed trigger.
          "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.
        },
        "lastTriggerTime": "A String", # Output only. The time of the most recent trigger initiation.
        "lastVerificationExecution": "A String", # Output only. The resource name of the most recent initiated RestoreTemplateExecution. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}`
        "nextTriggerTime": "A String", # Output only. The scheduled time of the next trigger initiation.
      },
      "updateTime": "A String", # Output only. The time when the association was updated.
    },
  ],
  "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.
triggerRestoreVerification(name, body=None, x__xgafv=None)
Triggers a new Restore Verification for the association in a given RestoreVerificationPlan.

Args:
  name: string, Required. The resource name of the RestoreVerificationPlanAssociation to trigger. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for TriggerRestoreVerification.
  "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 that the server has already received the duplicate request and can avoid responding with an error. 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.
  },
}