com.oracle.bmc.filestorage.model

Class ClientOptions

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.filestorage.model.ClientOptions

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class ClientOptions
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

NFS export options applied to a specified set of clients. Only governs access through the associated export. Access to the same file system through a different export (on the same or different mount target) will be governed by that export’s export options.
Note: Objects should always be created or deserialized using the ClientOptions.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 ClientOptions.Builder, which maintain a set of all explicitly set fields called ClientOptions.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientOptions.Access Type of access to grant clients using the file system through this export.
static class	ClientOptions.AllowedAuth
static class	ClientOptions.Builder
static class	ClientOptions.IdentitySquash Used when clients accessing the file system through this export have their UID and GID remapped to ‘anonymousUid’ and ‘anonymousGid’.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ClientOptions(String source, Boolean requirePrivilegedSourcePort, ClientOptions.Access access, ClientOptions.IdentitySquash identitySquash, Long anonymousUid, Long anonymousGid, Boolean isAnonymousAccessAllowed, List<ClientOptions.AllowedAuth> allowedAuth) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ClientOptions.Builder	builder() Create a new builder.
boolean	equals(Object o)
ClientOptions.Access	getAccess() Type of access to grant clients using the file system through this export.
List<ClientOptions.AllowedAuth>	getAllowedAuth() Array of allowed NFS authentication types.
Long	getAnonymousGid() GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
Long	getAnonymousUid() UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
ClientOptions.IdentitySquash	getIdentitySquash() Used when clients accessing the file system through this export have their UID and GID remapped to ‘anonymousUid’ and ‘anonymousGid’.
Boolean	getIsAnonymousAccessAllowed() Whether or not to enable anonymous access to the file system through this export in cases where a user isn’t found in the LDAP server used for ID mapping.
Boolean	getRequirePrivilegedSourcePort() If true, clients accessing the file system through this export must connect from a privileged source port.
String	getSource() Clients these options should apply to.
int	hashCode()
ClientOptions.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientOptions

@Deprecated
 @ConstructorProperties(value={"source","requirePrivilegedSourcePort","access","identitySquash","anonymousUid","anonymousGid","isAnonymousAccessAllowed","allowedAuth"})
public ClientOptions(String source,
                                                                                                                                                                                                          Boolean requirePrivilegedSourcePort,
                                                                                                                                                                                                          ClientOptions.Access access,
                                                                                                                                                                                                          ClientOptions.IdentitySquash identitySquash,
                                                                                                                                                                                                          Long anonymousUid,
                                                                                                                                                                                                          Long anonymousGid,
                                                                                                                                                                                                          Boolean isAnonymousAccessAllowed,
                                                                                                                                                                                                          List<ClientOptions.AllowedAuth> allowedAuth)

Deprecated.

Method Detail

builder

public static ClientOptions.Builder builder()

Create a new builder.

toBuilder

public ClientOptions.Builder toBuilder()

getSource

public String getSource()

Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

*Note:** Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

Returns:

the value

getRequirePrivilegedSourcePort

public Boolean getRequirePrivilegedSourcePort()

If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.

Returns:

the value

getAccess

public ClientOptions.Access getAccess()

Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.

Returns:

the value

getIdentitySquash

public ClientOptions.IdentitySquash getIdentitySquash()

Used when clients accessing the file system through this export have their UID and GID remapped to ‘anonymousUid’ and ‘anonymousGid’. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.

Returns:

the value

getAnonymousUid

public Long getAnonymousUid()

UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.

Returns:

the value

getAnonymousGid

public Long getAnonymousGid()

GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.

Returns:

the value

getIsAnonymousAccessAllowed

public Boolean getIsAnonymousAccessAllowed()

Whether or not to enable anonymous access to the file system through this export in cases where a user isn’t found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.

Returns:

the value

getAllowedAuth

public List<ClientOptions.AllowedAuth> getAllowedAuth()

Array of allowed NFS authentication types.

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