Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_plan_details
def backup_plan_details() -> ::Array<::Google::Cloud::BackupDR::V1::BackupPlanDetail>
Returns
- (::Array<::Google::Cloud::BackupDR::V1::BackupPlanDetail>) — Required. The backup plan details for matching resources.
#backup_plan_details=
def backup_plan_details=(value) -> ::Array<::Google::Cloud::BackupDR::V1::BackupPlanDetail>
Parameter
- value (::Array<::Google::Cloud::BackupDR::V1::BackupPlanDetail>) — Required. The backup plan details for matching resources.
Returns
- (::Array<::Google::Cloud::BackupDR::V1::BackupPlanDetail>) — Required. The backup plan details for matching resources.
#binding_summary
def binding_summary() -> ::Google::Cloud::BackupDR::V1::BindingSummary
Returns
- (::Google::Cloud::BackupDR::V1::BindingSummary) — Output only. Summary of total count of different containers covered through this policy.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the policy was created.
#criteria
def criteria() -> ::Google::Cloud::BackupDR::V1::Criteria
Returns
- (::Google::Cloud::BackupDR::V1::Criteria) — Required. The criteria for matching resources.
#criteria=
def criteria=(value) -> ::Google::Cloud::BackupDR::V1::Criteria
Parameter
- value (::Google::Cloud::BackupDR::V1::Criteria) — Required. The criteria for matching resources.
Returns
- (::Google::Cloud::BackupDR::V1::Criteria) — Required. The criteria for matching resources.
#description
def description() -> ::String
Returns
- (::String) — Optional. A description of the policy. The description must be at most 2048 characters.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. A description of the policy. The description must be at most 2048 characters.
Returns
- (::String) — Optional. A description of the policy. The description must be at most 2048 characters.
#etag
def etag() -> ::String
Returns
- (::String) — Output only. The etag for the policy. If this is provided on update, it must match the server's etag.
#etag=
def etag=(value) -> ::String
Parameter
- value (::String) — Output only. The etag for the policy. If this is provided on update, it must match the server's etag.
Returns
- (::String) — Output only. The etag for the policy. If this is provided on update, it must match the server's etag.
#name
def name() -> ::String
Returns
-
(::String) — Output only. Identifier. The resource name of the AutoProtectionPolicy.
Format:
projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
#policy_evaluation_summary
def policy_evaluation_summary() -> ::Google::Cloud::BackupDR::V1::PolicyEvaluationSummary
Returns
- (::Google::Cloud::BackupDR::V1::PolicyEvaluationSummary) — Output only. Summary of last policy evaluation when job was run per workload type.
#state
def state() -> ::Google::Cloud::BackupDR::V1::AutoProtectionPolicy::State
Returns
- (::Google::Cloud::BackupDR::V1::AutoProtectionPolicy::State) — Output only. The current state of the AutoProtectionPolicy.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the policy was last updated.