Google Cloud Backup Dr V1beta Client - Class CreateRestoreVerificationPlanRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class CreateRestoreVerificationPlanRequest.

The request message for creating a RestoreVerificationPlan.

Generated from protobuf message google.cloud.backupdr.v1beta.CreateRestoreVerificationPlanRequest

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The RestoreVerificationPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.

↳ restore_verification_plan_id string

Required. The name of the RestoreVerificationPlan to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, ^[a-z]([-a-z0-9]*[a-z0-9])?$.

↳ restore_verification_plan RestoreVerificationPlan

Required. The RestoreVerificationPlan resource object to create.

↳ request_id 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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getParent

Required. The RestoreVerificationPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.

Returns
Type Description
string

setParent

Required. The RestoreVerificationPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.

Parameter
Name Description
var string
Returns
Type Description
$this

getRestoreVerificationPlanId

Required. The name of the RestoreVerificationPlan to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, ^[a-z]([-a-z0-9]*[a-z0-9])?$.

Returns
Type Description
string

setRestoreVerificationPlanId

Required. The name of the RestoreVerificationPlan to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, ^[a-z]([-a-z0-9]*[a-z0-9])?$.

Parameter
Name Description
var string
Returns
Type Description
$this

getRestoreVerificationPlan

Required. The RestoreVerificationPlan resource object to create.

Returns
Type Description
RestoreVerificationPlan|null

hasRestoreVerificationPlan

clearRestoreVerificationPlan

setRestoreVerificationPlan

Required. The RestoreVerificationPlan resource object to create.

Parameter
Name Description
var RestoreVerificationPlan
Returns
Type Description
$this

getRequestId

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.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

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.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The RestoreVerificationPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1. Please see BackupDRClient::locationName() for help formatting this field.

restoreVerificationPlan RestoreVerificationPlan

Required. The RestoreVerificationPlan resource object to create.

restoreVerificationPlanId string

Required. The name of the RestoreVerificationPlan to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, ^[a-z]([-a-z0-9]*[a-z0-9])?$.

Returns
Type Description
CreateRestoreVerificationPlanRequest