Google Cloud Backup Dr V1 Client - Class CreateBackupPlanAssociationRequest (0.4.0)

Version latest

• 0.4.0 (latest)
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class CreateBackupPlanAssociationRequest.

Request message for creating a backup plan.

Generated from protobuf message google.cloud.backupdr.v1.CreateBackupPlanAssociationRequest

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The backup plan association project and location in the format projects/{project_id}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.
↳ backup_plan_association_id	string Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
↳ backup_plan_association	Google\Cloud\BackupDR\V1\BackupPlanAssociation Required. The resource being created
↳ 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 t he 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 backup plan association project and location in the format projects/{project_id}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.

Returns
Type	Description
string

setParent

Required. The backup plan association project and location in the format projects/{project_id}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBackupPlanAssociationId

Required. The name of the backup plan association to create. The name must be unique for the specified project and location.

Returns
Type	Description
string

setBackupPlanAssociationId

Required. The name of the backup plan association to create. The name must be unique for the specified project and location.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBackupPlanAssociation

Required. The resource being created

Returns
Type	Description
Google\Cloud\BackupDR\V1\BackupPlanAssociation|null

hasBackupPlanAssociation

clearBackupPlanAssociation

setBackupPlanAssociation

Required. The resource being created

Parameter
Name	Description
var	Google\Cloud\BackupDR\V1\BackupPlanAssociation

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 t he 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 t he 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 backup plan association project and location in the format projects/{project_id}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1. Please see Google\Cloud\BackupDR\V1\BackupDRClient::locationName() for help formatting this field.
backupPlanAssociation	Google\Cloud\BackupDR\V1\BackupPlanAssociation Required. The resource being created
backupPlanAssociationId	string Required. The name of the backup plan association to create. The name must be unique for the specified project and location.

Returns
Type	Description
Google\Cloud\BackupDR\V1\CreateBackupPlanAssociationRequest