FilesystemSnapshotPolicySummary¶
-
class
oci.file_storage.models.
FilesystemSnapshotPolicySummary
(**kwargs)¶ Bases:
object
Summary information for a file system snapshot policy.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. availability_domain
[Required] Gets the availability_domain of this FilesystemSnapshotPolicySummary. compartment_id
[Required] Gets the compartment_id of this FilesystemSnapshotPolicySummary. defined_tags
Gets the defined_tags of this FilesystemSnapshotPolicySummary. display_name
Gets the display_name of this FilesystemSnapshotPolicySummary. freeform_tags
Gets the freeform_tags of this FilesystemSnapshotPolicySummary. id
[Required] Gets the id of this FilesystemSnapshotPolicySummary. lifecycle_state
[Required] Gets the lifecycle_state of this FilesystemSnapshotPolicySummary. policy_prefix
Gets the policy_prefix of this FilesystemSnapshotPolicySummary. time_created
[Required] Gets the time_created of this FilesystemSnapshotPolicySummary. Methods
__init__
(**kwargs)Initializes a new FilesystemSnapshotPolicySummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicySummary. This constant has a value of “INACTIVE”
-
__init__
(**kwargs)¶ Initializes a new FilesystemSnapshotPolicySummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - availability_domain (str) – The value to assign to the availability_domain property of this FilesystemSnapshotPolicySummary.
- compartment_id (str) – The value to assign to the compartment_id property of this FilesystemSnapshotPolicySummary.
- id (str) – The value to assign to the id property of this FilesystemSnapshotPolicySummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this FilesystemSnapshotPolicySummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- display_name (str) – The value to assign to the display_name property of this FilesystemSnapshotPolicySummary.
- time_created (datetime) – The value to assign to the time_created property of this FilesystemSnapshotPolicySummary.
- policy_prefix (str) – The value to assign to the policy_prefix property of this FilesystemSnapshotPolicySummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FilesystemSnapshotPolicySummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FilesystemSnapshotPolicySummary.
-
availability_domain
¶ [Required] Gets the availability_domain of this FilesystemSnapshotPolicySummary. The availability domain that the file system snapshot policy is in. Example: Uocm:PHX-AD-1
Returns: The availability_domain of this FilesystemSnapshotPolicySummary. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this FilesystemSnapshotPolicySummary. The OCID of the compartment that contains the file system snapshot policy.
Returns: The compartment_id of this FilesystemSnapshotPolicySummary. Return type: str
Gets the defined_tags of this FilesystemSnapshotPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}
Returns: The defined_tags of this FilesystemSnapshotPolicySummary. Return type: dict(str, dict(str, object))
-
display_name
¶ Gets the display_name of this FilesystemSnapshotPolicySummary. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: My Filesystem Snapshot Policy
Returns: The display_name of this FilesystemSnapshotPolicySummary. Return type: str
Gets the freeform_tags of this FilesystemSnapshotPolicySummary. Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace.For more information, see Resource Tags. Example: {“Department”: “Finance”}
Returns: The freeform_tags of this FilesystemSnapshotPolicySummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this FilesystemSnapshotPolicySummary. The OCID of the file system snapshot policy.
Returns: The id of this FilesystemSnapshotPolicySummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this FilesystemSnapshotPolicySummary. The current state of this file system snapshot policy.
Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this FilesystemSnapshotPolicySummary. Return type: str
-
policy_prefix
¶ Gets the policy_prefix of this FilesystemSnapshotPolicySummary. The prefix to apply to all snapshots created by this policy.
Example: acme
Returns: The policy_prefix of this FilesystemSnapshotPolicySummary. Return type: str
-
time_created
¶ [Required] Gets the time_created of this FilesystemSnapshotPolicySummary. The date and time that the file system snapshot policy was created in RFC 3339 timestamp format. Example: 2020-02-04T21:10:29.600Z
Returns: The time_created of this FilesystemSnapshotPolicySummary. Return type: datetime
-