Package com.oracle.bmc.lustrefilestorage.model

Class LustreFileSystem

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public final class LustreFileSystem
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A Lustre file system is a parallel file system that is used as a storage solution for HPC/AI/ML workloads.

    For more information, see File Storage with Lustre.

    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 LustreFileSystem.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 LustreFileSystem.Builder, which maintain a set of all explicitly set fields called LustreFileSystem.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 Lustre file system.
        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 Lustre file system

        Returns:
        the value

      • getFileSystemDescription

        public String getFileSystemDescription()
        Short description of the Lustre file system.

        Avoid entering confidential information.

        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 Lustre file system 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 Lustre file system 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

      • getNsgIds

        public List<String> getNsgIds()
        A list of Network Security Group OCIDs associated with this lustre file system.

        A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the lustre file system from all NSGs. For more information about NSGs, see Security Rules.

        Returns:
        the value

      • getKmsKeyId

        public String getKmsKeyId()
        The OCID of the KMS key used to encrypt the encryption keys associated with this file system.
        Returns:
        the value

      • getCapacityInGBs

        public Integer getCapacityInGBs()
        Capacity of the Lustre file system in GB.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet the Lustre file system is in.
        Returns:
        the value

      • getPerformanceTier

        public LustreFileSystem.PerformanceTier getPerformanceTier()
        The Lustre file system performance tier.

        A value of MBPS_PER_TB_125 represents 125 megabytes per second per terabyte.

        Returns:
        the value

      • getManagementServiceAddress

        public String getManagementServiceAddress()
        The IPv4 address of MGS (Lustre Management Service) used by clients to mount the file system.

        For example ‘10.0.0.4’.

        Returns:
        the value

      • getFileSystemName

        public String getFileSystemName()
        The Lustre file system name.

        This is used in mount commands and other aspects of the client command line interface. The default file system name is ‘lustre’. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and ‘_’.

        Returns:
        the value

      • getLnet

        public String getLnet()
        Type of network used by clients to mount the file system.

        Example: tcp

        Returns:
        the value

      • getMajorVersion

        public String getMajorVersion()
        Major version of Lustre running in the Lustre file system.

        Example: 2.15

        Returns:
        the value

      • getClusterPlacementGroupId

        public String getClusterPlacementGroupId()
        The OCID of the cluster placement group in which the Lustre file system exists.
        Returns:
        the value

      • getTimeBillingCycleEnd

        public Date getTimeBillingCycleEnd()
        The date and time that the current billing cycle for the file system will end, expressed in RFC 3339 timestamp format.

        After the current cycle ends, this date is updated automatically to the next timestamp, which is 30 days later. File systems deleted earlier than this time will still incur charges until the billing cycle ends.

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

        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