ObjectStorageLink¶

class oci.lustre_file_storage.models.ObjectStorageLink(**kwargs)¶

Bases: object

Object Storage links create the relationship between a directory in an File Storage with Lustre file system and a path within an Object Storage bucket. For more information, see Syncing Lustre file systems with Object Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ObjectStorageLink.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ObjectStorageLink.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ObjectStorageLink.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ObjectStorageLink.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ObjectStorageLink.
`availability_domain`	[Required] Gets the availability_domain of this ObjectStorageLink.
`compartment_id`	[Required] Gets the compartment_id of this ObjectStorageLink.
`current_job_id`	Gets the current_job_id of this ObjectStorageLink.
`defined_tags`	[Required] Gets the defined_tags of this ObjectStorageLink.
`display_name`	[Required] Gets the display_name of this ObjectStorageLink.
`file_system_path`	[Required] Gets the file_system_path of this ObjectStorageLink.
`freeform_tags`	[Required] Gets the freeform_tags of this ObjectStorageLink.
`id`	[Required] Gets the id of this ObjectStorageLink.
`is_overwrite`	[Required] Gets the is_overwrite of this ObjectStorageLink.
`last_job_id`	Gets the last_job_id of this ObjectStorageLink.
`lifecycle_details`	Gets the lifecycle_details of this ObjectStorageLink.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ObjectStorageLink.
`lustre_file_system_id`	[Required] Gets the lustre_file_system_id of this ObjectStorageLink.
`object_storage_prefix`	[Required] Gets the object_storage_prefix of this ObjectStorageLink.
`system_tags`	[Required] Gets the system_tags of this ObjectStorageLink.
`time_created`	[Required] Gets the time_created of this ObjectStorageLink.
`time_updated`	[Required] Gets the time_updated of this ObjectStorageLink.

Methods

__init__(**kwargs) Initializes a new ObjectStorageLink object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ObjectStorageLink. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ObjectStorageLink. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ObjectStorageLink. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ObjectStorageLink. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ObjectStorageLink. This constant has a value of “FAILED”

__init__(**kwargs)¶

Initializes a new ObjectStorageLink object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this ObjectStorageLink.
compartment_id (str) – The value to assign to the compartment_id property of this ObjectStorageLink.
availability_domain (str) – The value to assign to the availability_domain property of this ObjectStorageLink.
display_name (str) – The value to assign to the display_name property of this ObjectStorageLink.
time_created (datetime) – The value to assign to the time_created property of this ObjectStorageLink.
time_updated (datetime) – The value to assign to the time_updated property of this ObjectStorageLink.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ObjectStorageLink. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ObjectStorageLink.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ObjectStorageLink.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ObjectStorageLink.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ObjectStorageLink.
lustre_file_system_id (str) – The value to assign to the lustre_file_system_id property of this ObjectStorageLink.
file_system_path (str) – The value to assign to the file_system_path property of this ObjectStorageLink.
object_storage_prefix (str) – The value to assign to the object_storage_prefix property of this ObjectStorageLink.
current_job_id (str) – The value to assign to the current_job_id property of this ObjectStorageLink.
last_job_id (str) – The value to assign to the last_job_id property of this ObjectStorageLink.
is_overwrite (bool) – The value to assign to the is_overwrite property of this ObjectStorageLink.

availability_domain¶

[Required] Gets the availability_domain of this ObjectStorageLink. 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 ObjectStorageLink.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ObjectStorageLink. The OCID of the compartment that contains the Lustre file system.

Returns:	The compartment_id of this ObjectStorageLink.
Return type:	str

current_job_id¶

Gets the current_job_id of this ObjectStorageLink. The OCID of currently running sync job. If no sync job is running, then this will be empty.

Returns:	The current_job_id of this ObjectStorageLink.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this ObjectStorageLink. 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 ObjectStorageLink.
Return type:	dict(str, dict(str, object))

display_name¶

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

Example: My Object Storage Link

Returns:	The display_name of this ObjectStorageLink.
Return type:	str

file_system_path¶

[Required] Gets the file_system_path of this ObjectStorageLink. The path in the Lustre file system used for this Object Storage link.

Example: myFileSystem/mount/myDirectory

Returns:	The file_system_path of this ObjectStorageLink.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this ObjectStorageLink. 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 ObjectStorageLink.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ObjectStorageLink. The OCID of the ObjectStorageLink.

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

is_overwrite¶

[Required] Gets the is_overwrite of this ObjectStorageLink. The flag is an identifier to tell whether the job run has overwrite enabled. If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists.

Returns:	The is_overwrite of this ObjectStorageLink.
Return type:	bool

last_job_id¶

Gets the last_job_id of this ObjectStorageLink. The OCID of last succeeded sync job. If no sync job has previously run, then this will be empty.

Returns:	The last_job_id of this ObjectStorageLink.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ObjectStorageLink. A message that describes the current state of the Object Storage link in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this ObjectStorageLink.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ObjectStorageLink. The current state of the Object Storage link.

Allowed values for this property are: “CREATING”, “ACTIVE”, “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 ObjectStorageLink.
Return type:	str

lustre_file_system_id¶

[Required] Gets the lustre_file_system_id of this ObjectStorageLink. The OCID of the associated Lustre file system.

Returns:	The lustre_file_system_id of this ObjectStorageLink.
Return type:	str

object_storage_prefix¶

[Required] Gets the object_storage_prefix of this ObjectStorageLink. The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports.

Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix

Returns:	The object_storage_prefix of this ObjectStorageLink.
Return type:	str

system_tags¶

[Required] Gets the system_tags of this ObjectStorageLink. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ObjectStorageLink.
Return type:	dict(str, dict(str, object))

time_created¶

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

Example: 2024-04-25T21:10:29.600Z

Returns:	The time_created of this ObjectStorageLink.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ObjectStorageLink. The date and time the Object Storage link was updated, in the format defined by RFC 3339.

Example: 2024-04-25T21:10:29.600Z

Returns:	The time_updated of this ObjectStorageLink.
Return type:	datetime