Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class AutoProtectionPolicy.
An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach.
The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.
Generated from protobuf message google.cloud.backupdr.v1beta.AutoProtectionPolicy
Namespace
Google \ Cloud \ BackupDR \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the AutoprotectionPolicy. Format: |
↳ description |
string
Optional. A description of the policy. |
↳ backup_plan_details |
array<BackupPlanDetail>
Required. The backup plan details for matching resources. |
↳ criteria |
Criteria
Required. The criteria for matching resources. |
↳ state |
int
Output only. The current state of the AutoprotectionPolicy. |
↳ etag |
string
Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error. |
↳ binding_summary |
BindingSummary
Output only. Summary of total count of different containers covered through this policy. |
↳ policy_evaluation_summary |
PolicyEvaluationSummary
Output only. Summary of last policy application when job was run per workload type. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the policy was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the policy was last updated. |
getName
Identifier. The resource name of the AutoprotectionPolicy.
Format:
projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the AutoprotectionPolicy.
Format:
projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the policy.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A description of the policy.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupPlanDetails
Required. The backup plan details for matching resources.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<BackupPlanDetail> |
|
setBackupPlanDetails
Required. The backup plan details for matching resources.
| Parameter | |
|---|---|
| Name | Description |
var |
array<BackupPlanDetail>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCriteria
Required. The criteria for matching resources.
| Returns | |
|---|---|
| Type | Description |
Criteria|null |
|
hasCriteria
clearCriteria
setCriteria
Required. The criteria for matching resources.
| Parameter | |
|---|---|
| Name | Description |
var |
Criteria
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the AutoprotectionPolicy.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The current state of the AutoprotectionPolicy.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Output only. The etag for the policy.
If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Output only. The etag for the policy.
If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBindingSummary
Output only. Summary of total count of different containers covered through this policy.
| Returns | |
|---|---|
| Type | Description |
BindingSummary|null |
|
hasBindingSummary
clearBindingSummary
setBindingSummary
Output only. Summary of total count of different containers covered through this policy.
| Parameter | |
|---|---|
| Name | Description |
var |
BindingSummary
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPolicyEvaluationSummary
Output only. Summary of last policy application when job was run per workload type.
| Returns | |
|---|---|
| Type | Description |
PolicyEvaluationSummary|null |
|
hasPolicyEvaluationSummary
clearPolicyEvaluationSummary
setPolicyEvaluationSummary
Output only. Summary of last policy application when job was run per workload type.
| Parameter | |
|---|---|
| Name | Description |
var |
PolicyEvaluationSummary
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the policy was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the policy was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the policy was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the policy was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|