models.snapshot_target_policy_proto module

class models.snapshot_target_policy_proto.SnapshotTargetPolicyProto(copy_partially_successful_run=None, granularity_bucket=None, id=None, num_days_to_keep=None, retention_policy=None, snapshot_target=None)

Bases: object

Implementation of the ‘SnapshotTargetPolicyProto’ model.

Message that specifies the policy for copying backup snapshots to a target. This message also specifies the retention policy that should be applied to the snapshots after they have been copied to the specified target.

Attributes:

copy_partially_successful_run (bool): If this is false, then only

snapshots from the first completely successful run in the given time granularity will be considered for being copied. If this is true, then snapshots from the first partially successful run will also be eligible to be copied.

granularity_bucket (GranularityBucket): Message that specifies the

frequency granularity at which to copy the snapshots from a backup job’s runs.

id (string): This id uniquely identifies this entry in the

ProtectionPolicyProto. If this message is from global policy, this id is generated by Helios. Otherwise, it is generated by Iris. Magneto uses this for merging linked policies with its parent global policy.

num_days_to_keep (long|int): Specifies how to determine the expiration

time for snapshots copied due to this policy. The snapshots will be marked as expiring (i.e., eligible to be garbage collected) in ‘num_days_to_keep’ days from when the snapshots were created.

retention_policy (RetentionPolicyProto): Message that specifies the

retention policy for backup snapshots.

snapshot_target (SnapshotTarget): Message that specifies details about

a target (such as a replication or archival target) where a backup snapshot may be copied to.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.