Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class TriggerBackupRequest.
Request message for triggering a backup.
Generated from protobuf message google.cloud.backupdr.v1beta.TriggerBackupRequest
Namespace
Google \ Cloud \ BackupDR \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the backup plan association resource, in the format |
↳ rule_id |
string
Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered. |
↳ 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 after 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). |
↳ custom_retention_days |
int
Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels to be applied on the backup. |
getName
Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the backup plan association resource, in the format
projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleId
Optional. backup rule_id for which a backup needs to be triggered.
If not specified, on-demand backup with custom retention will be triggered.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRuleId
Optional. backup rule_id for which a backup needs to be triggered.
If not specified, on-demand backup with custom retention will be triggered.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 after 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 after 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 |
|
getCustomRetentionDays
Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days".
It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCustomRetentionDays
Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days".
It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels to be applied on the backup.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels to be applied on the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the backup plan association resource, in the format
|
ruleId |
string
Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered. |
| Returns | |
|---|---|
| Type | Description |
TriggerBackupRequest |
|