Google Cloud Backup Dr V1beta Client - Class AppliedAutoProtectionPolicy (0.15.1)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class AppliedAutoProtectionPolicy.

AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and AutoProtectionPolicyBinding resources that apply to a given workload project.

Generated from protobuf message google.cloud.backupdr.v1beta.AppliedAutoProtectionPolicy

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. Canonical resource name. Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.

↳ source_binding string

Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.

↳ criteria Criteria

Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.

↳ backup_plan_details array<BackupPlanDetail>

Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp indicating when the binding was last modified.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp indicating when the binding was last created.

↳ binding_evaluation_summary BindingEvaluationSummary

Output only. The summary of the last policy application when the job has run.

↳ status int

Output only. The status of the applied auto protection policy.

getName

Identifier. Canonical resource name.

Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.

Returns
Type Description
string

setName

Identifier. Canonical resource name.

Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceBinding

Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.

Returns
Type Description
string

setSourceBinding

Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCriteria

Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.

Returns
Type Description
Criteria|null

hasCriteria

clearCriteria

setCriteria

Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.

Parameter
Name Description
var Criteria
Returns
Type Description
$this

getBackupPlanDetails

Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.

Returns
Type Description
Google\Protobuf\RepeatedField<BackupPlanDetail>

setBackupPlanDetails

Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.

Parameter
Name Description
var array<BackupPlanDetail>
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp indicating when the binding was last modified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp indicating when the binding was last modified.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreateTime

Output only. Timestamp indicating when the binding was last created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp indicating when the binding was last created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getBindingEvaluationSummary

Output only. The summary of the last policy application when the job has run.

Returns
Type Description
BindingEvaluationSummary|null

hasBindingEvaluationSummary

clearBindingEvaluationSummary

setBindingEvaluationSummary

Output only. The summary of the last policy application when the job has run.

Parameter
Name Description
var BindingEvaluationSummary
Returns
Type Description
$this

getStatus

Output only. The status of the applied auto protection policy.

Returns
Type Description
int Enum of type State.

setStatus

Output only. The status of the applied auto protection policy.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this