SnapshotSummary¶
- class oci.file_storage.models.SnapshotSummary(**kwargs)¶
Bases:
objectSummary information for a snapshot.
Attributes:
A constant which can be used with the lifecycle_state property of a SnapshotSummary.
A constant which can be used with the lifecycle_state property of a SnapshotSummary.
A constant which can be used with the lifecycle_state property of a SnapshotSummary.
A constant which can be used with the lifecycle_state property of a SnapshotSummary.
A constant which can be used with the snapshot_type property of a SnapshotSummary.
A constant which can be used with the snapshot_type property of a SnapshotSummary.
A constant which can be used with the snapshot_type property of a SnapshotSummary.
Gets the defined_tags of this SnapshotSummary.
Gets the exclusive_bytes of this SnapshotSummary.
Gets the expiration_time of this SnapshotSummary.
[Required] Gets the file_system_id of this SnapshotSummary.
Gets the freeform_tags of this SnapshotSummary. 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"}.
[Required] Gets the id of this SnapshotSummary.
Gets the is_clone_source of this SnapshotSummary.
Gets the lifecycle_details of this SnapshotSummary.
[Required] Gets the lifecycle_state of this SnapshotSummary.
Gets the lock_duration_details of this SnapshotSummary.
Gets the locks of this SnapshotSummary.
[Required] Gets the name of this SnapshotSummary.
Gets the provenance_id of this SnapshotSummary.
Gets the snapshot_time of this SnapshotSummary.
Gets the snapshot_type of this SnapshotSummary.
Gets the system_tags of this SnapshotSummary.
[Required] Gets the time_created of this SnapshotSummary.
Methods:
__init__(**kwargs)Initializes a new SnapshotSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a SnapshotSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a SnapshotSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SnapshotSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a SnapshotSummary. This constant has a value of “DELETING”
- SNAPSHOT_TYPE_POLICY_BASED = 'POLICY_BASED'¶
A constant which can be used with the snapshot_type property of a SnapshotSummary. This constant has a value of “POLICY_BASED”
- SNAPSHOT_TYPE_REPLICATION = 'REPLICATION'¶
A constant which can be used with the snapshot_type property of a SnapshotSummary. This constant has a value of “REPLICATION”
- SNAPSHOT_TYPE_USER = 'USER'¶
A constant which can be used with the snapshot_type property of a SnapshotSummary. This constant has a value of “USER”
- __init__(**kwargs)¶
Initializes a new SnapshotSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
file_system_id (str) – The value to assign to the file_system_id property of this SnapshotSummary.
id (str) – The value to assign to the id property of this SnapshotSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SnapshotSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this SnapshotSummary.
time_created (datetime) – The value to assign to the time_created property of this SnapshotSummary.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this SnapshotSummary.
lock_duration_details (oci.file_storage.models.LockDurationDetails) – The value to assign to the lock_duration_details property of this SnapshotSummary.
snapshot_type (str) – The value to assign to the snapshot_type property of this SnapshotSummary. Allowed values for this property are: “USER”, “POLICY_BASED”, “REPLICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
snapshot_time (datetime) – The value to assign to the snapshot_time property of this SnapshotSummary.
expiration_time (datetime) – The value to assign to the expiration_time property of this SnapshotSummary.
provenance_id (str) – The value to assign to the provenance_id property of this SnapshotSummary.
is_clone_source (bool) – The value to assign to the is_clone_source property of this SnapshotSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SnapshotSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SnapshotSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SnapshotSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SnapshotSummary.
exclusive_bytes (int) – The value to assign to the exclusive_bytes property of this SnapshotSummary.
- property defined_tags¶
Gets the defined_tags of this SnapshotSummary. 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 SnapshotSummary.
- Return type
dict(str, dict(str, object))
- property exclusive_bytes¶
Gets the exclusive_bytes of this SnapshotSummary. Bytes referenced only by this snapshot; deducted from compartment usage immediately upon deletion.
- Returns
The exclusive_bytes of this SnapshotSummary.
- Return type
int
- property expiration_time¶
Gets the expiration_time of this SnapshotSummary. The time when this snapshot will be deleted.
- Returns
The expiration_time of this SnapshotSummary.
- Return type
datetime
- property file_system_id¶
[Required] Gets the file_system_id of this SnapshotSummary. The `OCID`__ of the file system from which the snapshot was created.
- Returns
The file_system_id of this SnapshotSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this SnapshotSummary. 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 SnapshotSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this SnapshotSummary. The `OCID`__ of the snapshot.
- Returns
The id of this SnapshotSummary.
- Return type
str
- property is_clone_source¶
Gets the is_clone_source of this SnapshotSummary. Specifies whether the snapshot has been cloned. See `Cloning a File System`__.
- Returns
The is_clone_source of this SnapshotSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this SnapshotSummary. Additional information about the current lifecycleState.
- Returns
The lifecycle_details of this SnapshotSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this SnapshotSummary. The current state of the snapshot.
Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this SnapshotSummary.
- Return type
str
- property lock_duration_details¶
Gets the lock_duration_details of this SnapshotSummary.
- Returns
The lock_duration_details of this SnapshotSummary.
- Return type
- property locks¶
Gets the locks of this SnapshotSummary. Locks associated with this resource.
- Returns
The locks of this SnapshotSummary.
- Return type
- property name¶
[Required] Gets the name of this SnapshotSummary. Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: Sunday
- Returns
The name of this SnapshotSummary.
- Return type
str
- property provenance_id¶
Gets the provenance_id of this SnapshotSummary. An `OCID`__ identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the provenanceId is the same as the snapshot id value. If this snapshot was cloned, then the provenanceId value is the parent’s provenanceId. See `Cloning a File System`__.
- Returns
The provenance_id of this SnapshotSummary.
- Return type
str
- property snapshot_time¶
Gets the snapshot_time of this SnapshotSummary. The date and time the snapshot was taken, expressed in `RFC 3339`__ timestamp format. This value might be the same or different from timeCreated depending on the following factors: - If the snapshot is created in the original file system directory. - If the snapshot is cloned from a file system. - If the snapshot is replicated from a file system.
Example: 2020-08-25T21:10:29.600Z
- Returns
The snapshot_time of this SnapshotSummary.
- Return type
datetime
- property snapshot_type¶
Gets the snapshot_type of this SnapshotSummary. Specifies the generation type of the snapshot.
Allowed values for this property are: “USER”, “POLICY_BASED”, “REPLICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The snapshot_type of this SnapshotSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this SnapshotSummary. System tags for this resource. System tags are applied to resources by internal OCI services.
- Returns
The system_tags of this SnapshotSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this SnapshotSummary. The date and time the snapshot was created, expressed in `RFC 3339`__ timestamp format.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this SnapshotSummary.
- Return type
datetime