Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class CreateBackupPlanRequest.
Request message for CreateBackupPlan.
Generated from protobuf message google.cloud.gkebackup.v1.CreateBackupPlanRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The location within which to create the BackupPlan. Format: projects//locations/ Please see {@see \Google\Cloud\GkeBackup\V1\BackupForGKEClient::locationName()} for help formatting this field. |
backupPlan |
Google\Cloud\GkeBackup\V1\BackupPlan
Required. The BackupPlan resource object to create. |
backupPlanId |
string
Required. The client-provided short name for the BackupPlan resource. This name must:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\CreateBackupPlanRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The location within which to create the BackupPlan. Format: projects//locations/ |
↳ backup_plan |
Google\Cloud\GkeBackup\V1\BackupPlan
Required. The BackupPlan resource object to create. |
↳ backup_plan_id |
string
Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location |
getParent
Required. The location within which to create the BackupPlan.
Format: projects//locations/
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The location within which to create the BackupPlan.
Format: projects//locations/
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackupPlan
Required. The BackupPlan resource object to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\BackupPlan|null | |
hasBackupPlan
clearBackupPlan
setBackupPlan
Required. The BackupPlan resource object to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\BackupPlan
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackupPlanId
Required. The client-provided short name for the BackupPlan resource.
This name must:
- be between 1 and 63 characters long (inclusive)
- consist of only lower-case ASCII letters, numbers, and dashes
- start with a lower-case letter
- end with a lower-case letter or number
- be unique within the set of BackupPlans in this location
| Returns | |
|---|---|
| Type | Description |
string | |
setBackupPlanId
Required. The client-provided short name for the BackupPlan resource.
This name must:
- be between 1 and 63 characters long (inclusive)
- consist of only lower-case ASCII letters, numbers, and dashes
- start with a lower-case letter
- end with a lower-case letter or number
- be unique within the set of BackupPlans in this location
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |