Package com.oracle.bmc.lustrefilestorage.model

Class ObjectStorageLink

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public final class ObjectStorageLink
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the ObjectStorageLink.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ObjectStorageLink.Builder, which maintain a set of all explicitly set fields called ObjectStorageLink.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the ObjectStorageLink.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the Lustre file system.
        Returns:
        the value

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The availability domain the file system is in.

        May be unset as a blank or NULL value.

        Example: Uocm:PHX-AD-1

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        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 value

      • getTimeCreated

        public Date getTimeCreated()
        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 value

      • getTimeUpdated

        public Date getTimeUpdated()
        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 value

      • getLifecycleDetails

        public String getLifecycleDetails()
        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 value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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 value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • getLustreFileSystemId

        public String getLustreFileSystemId()
        The OCID of the associated Lustre file system.
        Returns:
        the value

      • getFileSystemPath

        public String getFileSystemPath()
        The path in the Lustre file system used for this Object Storage link.

        Example: myFileSystem/mount/myDirectory

        Returns:
        the value

      • getObjectStoragePrefix

        public String getObjectStoragePrefix()
        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 value

      • getCurrentJobId

        public String getCurrentJobId()
        The OCID of currently running sync job.

        If no sync job is running, then this will be empty.

        Returns:
        the value

      • getLastJobId

        public String getLastJobId()
        The OCID of last succeeded sync job.

        If no sync job has previously run, then this will be empty.

        Returns:
        the value

      • getIsOverwrite

        public Boolean getIsOverwrite()
        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 value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel