SnapshotSummary¶

class oci.file_storage.models.SnapshotSummary(**kwargs)¶

Bases: object

Summary information for a snapshot.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SnapshotSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SnapshotSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SnapshotSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SnapshotSummary.
`defined_tags`	Gets the defined_tags of this SnapshotSummary.
`file_system_id`	[Required] Gets the file_system_id of this SnapshotSummary.
`freeform_tags`	Gets the freeform_tags of this SnapshotSummary.
`id`	[Required] Gets the id of this SnapshotSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SnapshotSummary.
`name`	[Required] Gets the name of this SnapshotSummary.
`time_created`	[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”

__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.
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.

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))

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

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)

id¶

[Required] Gets the id of this SnapshotSummary. The OCID of the snapshot.

Returns:	The id of this SnapshotSummary.
Return type:	str

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

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

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