Class NfsExportOptions (1.45.0)

public final class NfsExportOptions extends GeneratedMessageV3 implements NfsExportOptionsOrBuilder

NFS export options specifications.

Protobuf type google.cloud.filestore.v1beta1.NfsExportOptions

Static Fields

ACCESS_MODE_FIELD_NUMBER

public static final int ACCESS_MODE_FIELD_NUMBER
Field Value
Type Description
int

ANON_GID_FIELD_NUMBER

public static final int ANON_GID_FIELD_NUMBER
Field Value
Type Description
int

ANON_UID_FIELD_NUMBER

public static final int ANON_UID_FIELD_NUMBER
Field Value
Type Description
int

IP_RANGES_FIELD_NUMBER

public static final int IP_RANGES_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_FLAVORS_FIELD_NUMBER

public static final int SECURITY_FLAVORS_FIELD_NUMBER
Field Value
Type Description
int

SQUASH_MODE_FIELD_NUMBER

public static final int SQUASH_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static NfsExportOptions getDefaultInstance()
Returns
Type Description
NfsExportOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static NfsExportOptions.Builder newBuilder()
Returns
Type Description
NfsExportOptions.Builder

newBuilder(NfsExportOptions prototype)

public static NfsExportOptions.Builder newBuilder(NfsExportOptions prototype)
Parameter
Name Description
prototype NfsExportOptions
Returns
Type Description
NfsExportOptions.Builder

parseDelimitedFrom(InputStream input)

public static NfsExportOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static NfsExportOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NfsExportOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NfsExportOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static NfsExportOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static NfsExportOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NfsExportOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NfsExportOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<NfsExportOptions> parser()
Returns
Type Description
Parser<NfsExportOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessMode()

public NfsExportOptions.AccessMode getAccessMode()

Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

.google.cloud.filestore.v1beta1.NfsExportOptions.AccessMode access_mode = 2;

Returns
Type Description
NfsExportOptions.AccessMode

The accessMode.

getAccessModeValue()

public int getAccessModeValue()

Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

.google.cloud.filestore.v1beta1.NfsExportOptions.AccessMode access_mode = 2;

Returns
Type Description
int

The enum numeric value on the wire for accessMode.

getAnonGid()

public long getAnonGid()

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

int64 anon_gid = 5;

Returns
Type Description
long

The anonGid.

getAnonUid()

public long getAnonUid()

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

int64 anon_uid = 4;

Returns
Type Description
long

The anonUid.

getDefaultInstanceForType()

public NfsExportOptions getDefaultInstanceForType()
Returns
Type Description
NfsExportOptions

getIpRanges(int index)

public String getIpRanges(int index)

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

repeated string ip_ranges = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The ipRanges at the given index.

getIpRangesBytes(int index)

public ByteString getIpRangesBytes(int index)

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

repeated string ip_ranges = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the ipRanges at the given index.

getIpRangesCount()

public int getIpRangesCount()

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

repeated string ip_ranges = 1;

Returns
Type Description
int

The count of ipRanges.

getIpRangesList()

public ProtocolStringList getIpRangesList()

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

repeated string ip_ranges = 1;

Returns
Type Description
ProtocolStringList

A list containing the ipRanges.

getParserForType()

public Parser<NfsExportOptions> getParserForType()
Returns
Type Description
Parser<NfsExportOptions>
Overrides

getSecurityFlavors(int index)

public NfsExportOptions.SecurityFlavor getSecurityFlavors(int index)

The security flavors allowed for mount operations. The default is AUTH_SYS.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions.SecurityFlavor security_flavors = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
NfsExportOptions.SecurityFlavor

The securityFlavors at the given index.

getSecurityFlavorsCount()

public int getSecurityFlavorsCount()

The security flavors allowed for mount operations. The default is AUTH_SYS.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions.SecurityFlavor security_flavors = 6;

Returns
Type Description
int

The count of securityFlavors.

getSecurityFlavorsList()

public List<NfsExportOptions.SecurityFlavor> getSecurityFlavorsList()

The security flavors allowed for mount operations. The default is AUTH_SYS.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions.SecurityFlavor security_flavors = 6;

Returns
Type Description
List<SecurityFlavor>

A list containing the securityFlavors.

getSecurityFlavorsValue(int index)

public int getSecurityFlavorsValue(int index)

The security flavors allowed for mount operations. The default is AUTH_SYS.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions.SecurityFlavor security_flavors = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of securityFlavors at the given index.

getSecurityFlavorsValueList()

public List<Integer> getSecurityFlavorsValueList()

The security flavors allowed for mount operations. The default is AUTH_SYS.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions.SecurityFlavor security_flavors = 6;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for securityFlavors.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSquashMode()

public NfsExportOptions.SquashMode getSquashMode()

Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

.google.cloud.filestore.v1beta1.NfsExportOptions.SquashMode squash_mode = 3;

Returns
Type Description
NfsExportOptions.SquashMode

The squashMode.

getSquashModeValue()

public int getSquashModeValue()

Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

.google.cloud.filestore.v1beta1.NfsExportOptions.SquashMode squash_mode = 3;

Returns
Type Description
int

The enum numeric value on the wire for squashMode.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public NfsExportOptions.Builder newBuilderForType()
Returns
Type Description
NfsExportOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NfsExportOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NfsExportOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public NfsExportOptions.Builder toBuilder()
Returns
Type Description
NfsExportOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException