# Google Cloud Backup Dr V1 Client - Class CreateBackupPlanRequest (0.13.0)

0.13.0 (latest) 0.12.1 0.11.1 0.10.0 0.9.0 0.8.1 0.7.0 0.6.2 0.5.1 0.4.2 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class CreateBackupPlanRequest.

The request message for creating a `BackupPlan`.

Generated from protobuf message `google.cloud.backupdr.v1.CreateBackupPlanRequest`

## Namespace

Google \\ Cloud \\ BackupDR \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**. |
| `↳ backup_plan_id` | `string` Required. The name of the `BackupPlan` 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-\]{,62}/. |
| `↳ backup_plan` | `https://docs.cloud.google.com/php/docs/reference/cloud-backupdr/latest/V1.BackupPlan` Required. The `BackupPlan` 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 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 `BackupPlan` project and location in the format
`projects/{project}/locations/{location}`. In Cloud BackupDR locations
map to GCP regions, for example **us-central1**.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

Required. The `BackupPlan` project and location in the format
`projects/{project}/locations/{location}`. In Cloud BackupDR locations
map to GCP regions, for example **us-central1**.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBackupPlanId

Required. The name of the `BackupPlan` 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-\]{,62}/.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBackupPlanId

Required. The name of the `BackupPlan` 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-\]{,62}/.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBackupPlan

Required. The `BackupPlan` resource object to create.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-backupdr/latest/V1.BackupPlan|null` |   |

### hasBackupPlan

### clearBackupPlan

### setBackupPlan

Required. The `BackupPlan` resource object to create.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-backupdr/latest/V1.BackupPlan` |

| **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 `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1** . Please see BackupDRClient::locationName() for help formatting this field. |
| `backupPlan` | `https://docs.cloud.google.com/php/docs/reference/cloud-backupdr/latest/V1.BackupPlan` Required. The `BackupPlan` resource object to create. |
| `backupPlanId` | `string` Required. The name of the `BackupPlan` 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-\]{,62}/. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-backupdr/latest/V1.CreateBackupPlanRequest` |   |