FileSystemSummary

class oci.file_storage.models.FileSystemSummary(**kwargs)

Bases: object

Summary information for a file system.

Attributes:

CLONE_ATTACH_STATUS_ATTACHED

A constant which can be used with the clone_attach_status property of a FileSystemSummary.

CLONE_ATTACH_STATUS_DETACHED

A constant which can be used with the clone_attach_status property of a FileSystemSummary.

CLONE_ATTACH_STATUS_DETACHING

A constant which can be used with the clone_attach_status property of a FileSystemSummary.

COMPARTMENT_QUOTA_ENFORCEMENT_STATE_BLOCKED

A constant which can be used with the compartment_quota_enforcement_state property of a FileSystemSummary.

COMPARTMENT_QUOTA_ENFORCEMENT_STATE_NOT_BLOCKED

A constant which can be used with the compartment_quota_enforcement_state property of a FileSystemSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_DISABLED

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_DISABLING

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_ENABLED

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_ENABLING

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_FAILED

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

QUOTA_ENFORCEMENT_STATE_SYNCING

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.

availability_domain

Gets the availability_domain of this FileSystemSummary.

clone_attach_status

Gets the clone_attach_status of this FileSystemSummary.

compartment_id

[Required] Gets the compartment_id of this FileSystemSummary.

compartment_quota_enforcement_state

Gets the compartment_quota_enforcement_state of this FileSystemSummary.

defined_tags

Gets the defined_tags of this FileSystemSummary.

display_name

[Required] Gets the display_name of this FileSystemSummary.

freeform_tags

Gets the freeform_tags of this FileSystemSummary. 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"}.

id

[Required] Gets the id of this FileSystemSummary.

is_clone_parent

Gets the is_clone_parent of this FileSystemSummary.

is_hydrated

Gets the is_hydrated of this FileSystemSummary.

kms_key_id

Gets the kms_key_id of this FileSystemSummary.

lifecycle_details

Gets the lifecycle_details of this FileSystemSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this FileSystemSummary.

locks

Gets the locks of this FileSystemSummary.

metered_bytes

[Required] Gets the metered_bytes of this FileSystemSummary.

quota_enforcement_state

Gets the quota_enforcement_state of this FileSystemSummary.

replication_source_count

Gets the replication_source_count of this FileSystemSummary.

source_details

Gets the source_details of this FileSystemSummary.

system_tags

Gets the system_tags of this FileSystemSummary.

time_created

[Required] Gets the time_created of this FileSystemSummary.

Methods:

__init__(**kwargs)

Initializes a new FileSystemSummary object with values from keyword arguments.

CLONE_ATTACH_STATUS_ATTACHED = 'ATTACHED'

A constant which can be used with the clone_attach_status property of a FileSystemSummary. This constant has a value of “ATTACHED”

CLONE_ATTACH_STATUS_DETACHED = 'DETACHED'

A constant which can be used with the clone_attach_status property of a FileSystemSummary. This constant has a value of “DETACHED”

CLONE_ATTACH_STATUS_DETACHING = 'DETACHING'

A constant which can be used with the clone_attach_status property of a FileSystemSummary. This constant has a value of “DETACHING”

COMPARTMENT_QUOTA_ENFORCEMENT_STATE_BLOCKED = 'BLOCKED'

A constant which can be used with the compartment_quota_enforcement_state property of a FileSystemSummary. This constant has a value of “BLOCKED”

COMPARTMENT_QUOTA_ENFORCEMENT_STATE_NOT_BLOCKED = 'NOT_BLOCKED'

A constant which can be used with the compartment_quota_enforcement_state property of a FileSystemSummary. This constant has a value of “NOT_BLOCKED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a FileSystemSummary. This constant has a value of “UPDATING”

QUOTA_ENFORCEMENT_STATE_DISABLED = 'DISABLED'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “DISABLED”

QUOTA_ENFORCEMENT_STATE_DISABLING = 'DISABLING'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “DISABLING”

QUOTA_ENFORCEMENT_STATE_ENABLED = 'ENABLED'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “ENABLED”

QUOTA_ENFORCEMENT_STATE_ENABLING = 'ENABLING'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “ENABLING”

QUOTA_ENFORCEMENT_STATE_FAILED = 'FAILED'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “FAILED”

QUOTA_ENFORCEMENT_STATE_SYNCING = 'SYNCING'

A constant which can be used with the quota_enforcement_state property of a FileSystemSummary. This constant has a value of “SYNCING”

__init__(**kwargs)

Initializes a new FileSystemSummary 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 FileSystemSummary.

  • metered_bytes (int) – The value to assign to the metered_bytes property of this FileSystemSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this FileSystemSummary.

  • display_name (str) – The value to assign to the display_name property of this FileSystemSummary.

  • id (str) – The value to assign to the id property of this FileSystemSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this FileSystemSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this FileSystemSummary.

  • locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this FileSystemSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FileSystemSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FileSystemSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this FileSystemSummary.

  • replication_source_count (int) – The value to assign to the replication_source_count property of this FileSystemSummary.

  • kms_key_id (str) – The value to assign to the kms_key_id property of this FileSystemSummary.

  • source_details (oci.file_storage.models.SourceDetails) – The value to assign to the source_details property of this FileSystemSummary.

  • is_clone_parent (bool) – The value to assign to the is_clone_parent property of this FileSystemSummary.

  • is_hydrated (bool) – The value to assign to the is_hydrated property of this FileSystemSummary.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this FileSystemSummary.

  • clone_attach_status (str) – The value to assign to the clone_attach_status property of this FileSystemSummary. Allowed values for this property are: “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • quota_enforcement_state (str) – The value to assign to the quota_enforcement_state property of this FileSystemSummary. Allowed values for this property are: “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “SYNCING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_quota_enforcement_state (str) – The value to assign to the compartment_quota_enforcement_state property of this FileSystemSummary. Allowed values for this property are: “NOT_BLOCKED”, “BLOCKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property availability_domain

Gets the availability_domain of this FileSystemSummary. The availability domain the file system is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns

The availability_domain of this FileSystemSummary.

Return type

str

property clone_attach_status

Gets the clone_attach_status of this FileSystemSummary. Specifies whether the file system is attached to its parent file system.

Allowed values for this property are: “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The clone_attach_status of this FileSystemSummary.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this FileSystemSummary. The `OCID`__ of the compartment that contains the file system.

Returns

The compartment_id of this FileSystemSummary.

Return type

str

property compartment_quota_enforcement_state

Gets the compartment_quota_enforcement_state of this FileSystemSummary. Displays the compartment-level quota enforcement state affecting this file system.

Allowed values for this property are: “NOT_BLOCKED”, “BLOCKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The compartment_quota_enforcement_state of this FileSystemSummary.

Return type

str

property defined_tags

Gets the defined_tags of this FileSystemSummary. 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 FileSystemSummary.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this FileSystemSummary. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: My file system

Returns

The display_name of this FileSystemSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this FileSystemSummary. 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 FileSystemSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this FileSystemSummary. The `OCID`__ of the file system.

Returns

The id of this FileSystemSummary.

Return type

str

property is_clone_parent

Gets the is_clone_parent of this FileSystemSummary. Specifies whether the file system has been cloned. See `Cloning a File System`__.

Returns

The is_clone_parent of this FileSystemSummary.

Return type

bool

property is_hydrated

Gets the is_hydrated of this FileSystemSummary. Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See `Cloning a File System`__.

Returns

The is_hydrated of this FileSystemSummary.

Return type

bool

property kms_key_id

Gets the kms_key_id of this FileSystemSummary. The `OCID`__ of the KMS key used to encrypt the encryption keys associated with this file system.

Returns

The kms_key_id of this FileSystemSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this FileSystemSummary. Additional information about the current ‘lifecycleState’.

Returns

The lifecycle_details of this FileSystemSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this FileSystemSummary. The current state of the file system.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this FileSystemSummary.

Return type

str

property locks

Gets the locks of this FileSystemSummary. Locks associated with this resource.

Returns

The locks of this FileSystemSummary.

Return type

list[oci.file_storage.models.ResourceLock]

property metered_bytes

[Required] Gets the metered_bytes of this FileSystemSummary. The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system.

Returns

The metered_bytes of this FileSystemSummary.

Return type

int

property quota_enforcement_state

Gets the quota_enforcement_state of this FileSystemSummary. Displays the state of enforcement of quota rules on the file system.

Allowed values for this property are: “ENABLING”, “ENABLED”, “DISABLING”, “DISABLED”, “SYNCING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The quota_enforcement_state of this FileSystemSummary.

Return type

str

property replication_source_count

Gets the replication_source_count of this FileSystemSummary. Specifies the total number of replications for which this file system is a source.

Returns

The replication_source_count of this FileSystemSummary.

Return type

int

property source_details

Gets the source_details of this FileSystemSummary.

Returns

The source_details of this FileSystemSummary.

Return type

oci.file_storage.models.SourceDetails

property system_tags

Gets the system_tags of this FileSystemSummary. System tags for this resource. System tags are applied to resources by internal OCI services.

Returns

The system_tags of this FileSystemSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this FileSystemSummary. The date and time the file system was created, expressed in `RFC 3339`__ timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this FileSystemSummary.

Return type

datetime