Class Volume (0.55.0)

public final class Volume extends GeneratedMessageV3 implements VolumeOrBuilder

Volume describes a volume and parameters for it to be mounted to a VM.

Protobuf type google.cloud.batch.v1.Volume

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Volume

Implements

VolumeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DEVICE_NAME_FIELD_NUMBER

public static final int DEVICE_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

GCS_FIELD_NUMBER

public static final int GCS_FIELD_NUMBER

Field Value
Type	Description
`int`

MOUNT_OPTIONS_FIELD_NUMBER

public static final int MOUNT_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

MOUNT_PATH_FIELD_NUMBER

public static final int MOUNT_PATH_FIELD_NUMBER

Field Value
Type	Description
`int`

NFS_FIELD_NUMBER

public static final int NFS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Volume getDefaultInstance()

Returns
Type	Description
`Volume`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Volume.Builder newBuilder()

Returns
Type	Description
`Volume.Builder`

newBuilder(Volume prototype)

public static Volume.Builder newBuilder(Volume prototype)

Parameter
Name	Description
`prototype`	`Volume`

Returns
Type	Description
`Volume.Builder`

parseDelimitedFrom(InputStream input)

public static Volume parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Volume parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Volume parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Volume parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Volume parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Volume parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Volume`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Volume> parser()

Returns
Type	Description
`Parser<Volume>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Volume getDefaultInstanceForType()

Returns
Type	Description
`Volume`

getDeviceName()

public String getDeviceName()

Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.

string device_name = 6;

Returns
Type	Description
`String`	The deviceName.

getDeviceNameBytes()

public ByteString getDeviceNameBytes()

string device_name = 6;

Returns
Type	Description
`ByteString`	The bytes for deviceName.

getGcs()

public GCS getGcs()

A Google Cloud Storage (GCS) volume.

.google.cloud.batch.v1.GCS gcs = 3;

Returns
Type	Description
`GCS`	The gcs.

getGcsOrBuilder()

public GCSOrBuilder getGcsOrBuilder()

A Google Cloud Storage (GCS) volume.

.google.cloud.batch.v1.GCS gcs = 3;

Returns
Type	Description
`GCSOrBuilder`

getMountOptions(int index)

public String getMountOptions(int index)

Mount options vary based on the type of storage volume:

For a Cloud Storage bucket, all the mount options provided by the gcsfuse tool are supported.
For an existing persistent disk, all mount options provided by the mount command except writing are supported. This is due to restrictions of multi-writer mode.
For any other disk or a Network File System (NFS), all the mount options provided by the mount command are supported.

repeated string mount_options = 5;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The mountOptions at the given index.

getMountOptionsBytes(int index)

public ByteString getMountOptionsBytes(int index)

Mount options vary based on the type of storage volume:

For a Cloud Storage bucket, all the mount options provided by the gcsfuse tool are supported.
For an existing persistent disk, all mount options provided by the mount command except writing are supported. This is due to restrictions of multi-writer mode.
For any other disk or a Network File System (NFS), all the mount options provided by the mount command are supported.

repeated string mount_options = 5;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the mountOptions at the given index.

getMountOptionsCount()

public int getMountOptionsCount()

Mount options vary based on the type of storage volume:

For a Cloud Storage bucket, all the mount options provided by the gcsfuse tool are supported.
For an existing persistent disk, all mount options provided by the mount command except writing are supported. This is due to restrictions of multi-writer mode.
For any other disk or a Network File System (NFS), all the mount options provided by the mount command are supported.

repeated string mount_options = 5;

Returns
Type	Description
`int`	The count of mountOptions.

getMountOptionsList()

public ProtocolStringList getMountOptionsList()

Mount options vary based on the type of storage volume:

For a Cloud Storage bucket, all the mount options provided by the gcsfuse tool are supported.
For an existing persistent disk, all mount options provided by the mount command except writing are supported. This is due to restrictions of multi-writer mode.
For any other disk or a Network File System (NFS), all the mount options provided by the mount command are supported.

repeated string mount_options = 5;

Returns
Type	Description
`ProtocolStringList`	A list containing the mountOptions.

getMountPath()

public String getMountPath()

The mount path for the volume, e.g. /mnt/disks/share.

string mount_path = 4;

Returns
Type	Description
`String`	The mountPath.

getMountPathBytes()

public ByteString getMountPathBytes()

The mount path for the volume, e.g. /mnt/disks/share.

string mount_path = 4;

Returns
Type	Description
`ByteString`	The bytes for mountPath.

getNfs()

public NFS getNfs()

A Network File System (NFS) volume. For example, a Filestore file share.

.google.cloud.batch.v1.NFS nfs = 1;

Returns
Type	Description
`NFS`	The nfs.

getNfsOrBuilder()

public NFSOrBuilder getNfsOrBuilder()

A Network File System (NFS) volume. For example, a Filestore file share.

.google.cloud.batch.v1.NFS nfs = 1;

Returns
Type	Description
`NFSOrBuilder`

getParserForType()

public Parser<Volume> getParserForType()

Returns
Type	Description
`Parser<Volume>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSourceCase()

public Volume.SourceCase getSourceCase()

Returns
Type	Description
`Volume.SourceCase`

hasDeviceName()

public boolean hasDeviceName()

string device_name = 6;

Returns
Type	Description
`boolean`	Whether the deviceName field is set.

hasGcs()

public boolean hasGcs()

A Google Cloud Storage (GCS) volume.

.google.cloud.batch.v1.GCS gcs = 3;

Returns
Type	Description
`boolean`	Whether the gcs field is set.

hasNfs()

public boolean hasNfs()

A Network File System (NFS) volume. For example, a Filestore file share.

.google.cloud.batch.v1.NFS nfs = 1;

Returns
Type	Description
`boolean`	Whether the nfs field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Volume.Builder newBuilderForType()

Returns
Type	Description
`Volume.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Volume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Volume.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Volume.Builder toBuilder()

Returns
Type	Description
`Volume.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`