Package com.oracle.bmc.filestorage.model

Class Export

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class Export
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A file system and the path that you can use to mount it.

    Each export resource belongs to exactly one export set.

    The export's path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system.

    The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a 'DELETED' state, the path element sequence for the first export resource can't contain the complete path element sequence of the second export resource.

    For example, the following are acceptable:

    /example and /path * /example1 and /example2 * /example and /example1

    The following examples are not acceptable: * /example and /example/path * / and /example

    Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less.

    No two non-'DELETED' export resources in the same export set can reference the same file system.

    Use exportOptions to control access to an export. For more information, see [Export Options](https://docs.oracle.com/iaas/Content/File/Tasks/exportoptions.htm).
    Note: Objects should always be created or deserialized using the Export.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 Export.Builder, which maintain a set of all explicitly set fields called Export.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

      • builder

        public static Export.Builder builder()
        Create a new builder.

      • getExportOptions

        public List<ClientOptions> getExportOptions()
        Policies that apply to NFS requests made through this export.

        exportOptions contains a sequential list of ClientOptions. Each ClientOptions item defines the export options that are applied to a specified set of clients.

        For each NFS request, the first ClientOptions option in the list whose source attribute matches the source IP address of the request is applied.

        If a client source IP address does not match the source property of any ClientOptions in the list, then the export will be invisible to that client. This export will not be returned by MOUNTPROC_EXPORT calls made by the client and any attempt to mount or access the file system through this export will result in an error.

        *Exports without defined ClientOptions are invisible to all clients.**

        If one export is invisible to a particular client, associated file systems may still be accessible through other exports on the same or different mount targets. To completely deny client access to a file system, be sure that the client source IP address is not included in any export for any mount target associated with the file system.

        Returns:
        the value

      • getExportSetId

        public String getExportSetId()
        The OCID of this export’s export set.
        Returns:
        the value

      • getFileSystemId

        public String getFileSystemId()
        The OCID of this export’s file system.
        Returns:
        the value

      • getId

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

      • getLifecycleState

        public Export.LifecycleState getLifecycleState()
        The current state of this export.
        Returns:
        the value

      • getPath

        public String getPath()
        Path used to access the associated file system.

        Avoid entering confidential information.

        Example: /accounting

        Returns:
        the value

      • getIsIdmapGroupsForSysAuth

        public Boolean getIsIdmapGroupsForSysAuth()
        Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request’s RPC header.

        When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the export 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

      • 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