Package com.oracle.bmc.filestorage.model

Class FileSystemSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class FileSystemSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Summary information for a file system.
    Note: Objects should always be created or deserialized using the FileSystemSummary.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 FileSystemSummary.Builder, which maintain a set of all explicitly set fields called FileSystemSummary.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

      • 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

      • getMeteredBytes

        public Long getMeteredBytes()
        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 value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the file system.
        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 file system

        Returns:
        the value

      • getId

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

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the file system was created, expressed in RFC 3339 timestamp format.

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

        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        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.

        System tags are applied to resources by internal OCI services.

        Returns:
        the value

      • getReplicationSourceCount

        public Integer getReplicationSourceCount()
        Specifies the total number of replications for which this file system is a source.
        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

      • getIsCloneParent

        public Boolean getIsCloneParent()
        Specifies whether the file system has been cloned.

        See Cloning a File System.

        Returns:
        the value

      • getIsHydrated

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

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current ‘lifecycleState’.
        Returns:
        the value

      • getCloneAttachStatus

        public FileSystemSummary.CloneAttachStatus getCloneAttachStatus()
        Specifies whether the file system is attached to its parent file system.
        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