Class Volume (0.1.0)

public final class Volume extends GeneratedMessageV3 implements VolumeOrBuilder

Volume and mount parameters to be associated with a TaskSpec. A TaskSpec might describe zero, one, or multiple volumes to be mounted as part of the task.

Protobuf type google.cloud.batch.v1.Volume

Implements

VolumeOrBuilder

Static Fields

DEVICE_NAME_FIELD_NUMBER

public static final int DEVICE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_FIELD_NUMBER

public static final int GCS_FIELD_NUMBER
Field Value
TypeDescription
int

MOUNT_OPTIONS_FIELD_NUMBER

public static final int MOUNT_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

MOUNT_PATH_FIELD_NUMBER

public static final int MOUNT_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

NFS_FIELD_NUMBER

public static final int NFS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Volume getDefaultInstance()
Returns
TypeDescription
Volume

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Volume.Builder newBuilder()
Returns
TypeDescription
Volume.Builder

newBuilder(Volume prototype)

public static Volume.Builder newBuilder(Volume prototype)
Parameter
NameDescription
prototypeVolume
Returns
TypeDescription
Volume.Builder

parseDelimitedFrom(InputStream input)

public static Volume parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Volume parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Volume parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Volume parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Volume parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Volume parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Volume parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Volume
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Volume> parser()
Returns
TypeDescription
Parser<Volume>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Volume getDefaultInstanceForType()
Returns
TypeDescription
Volume

getDeviceName()

public String getDeviceName()

Device name of an attached disk

string device_name = 6;

Returns
TypeDescription
String

The deviceName.

getDeviceNameBytes()

public ByteString getDeviceNameBytes()

Device name of an attached disk

string device_name = 6;

Returns
TypeDescription
ByteString

The bytes for deviceName.

getGcs()

public GCS getGcs()

A Google Cloud Storage source for the volume.

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

Returns
TypeDescription
GCS

The gcs.

getGcsOrBuilder()

public GCSOrBuilder getGcsOrBuilder()

A Google Cloud Storage source for the volume.

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

Returns
TypeDescription
GCSOrBuilder

getMountOptions(int index)

public String getMountOptions(int index)

Mount options For Google Cloud Storage, mount options are the global options supported by gcsfuse tool. Batch will use them to mount the volume with the following command: "gcsfuse [global options] bucket mountpoint". For PD, NFS, mount options are these supported by /etc/fstab. Batch will use Fstab to mount such volumes. https://help.ubuntu.com/community/Fstab

repeated string mount_options = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The mountOptions at the given index.

getMountOptionsBytes(int index)

public ByteString getMountOptionsBytes(int index)

Mount options For Google Cloud Storage, mount options are the global options supported by gcsfuse tool. Batch will use them to mount the volume with the following command: "gcsfuse [global options] bucket mountpoint". For PD, NFS, mount options are these supported by /etc/fstab. Batch will use Fstab to mount such volumes. https://help.ubuntu.com/community/Fstab

repeated string mount_options = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the mountOptions at the given index.

getMountOptionsCount()

public int getMountOptionsCount()

Mount options For Google Cloud Storage, mount options are the global options supported by gcsfuse tool. Batch will use them to mount the volume with the following command: "gcsfuse [global options] bucket mountpoint". For PD, NFS, mount options are these supported by /etc/fstab. Batch will use Fstab to mount such volumes. https://help.ubuntu.com/community/Fstab

repeated string mount_options = 5;

Returns
TypeDescription
int

The count of mountOptions.

getMountOptionsList()

public ProtocolStringList getMountOptionsList()

Mount options For Google Cloud Storage, mount options are the global options supported by gcsfuse tool. Batch will use them to mount the volume with the following command: "gcsfuse [global options] bucket mountpoint". For PD, NFS, mount options are these supported by /etc/fstab. Batch will use Fstab to mount such volumes. https://help.ubuntu.com/community/Fstab

repeated string mount_options = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the mountOptions.

getMountPath()

public String getMountPath()

Mount path for the volume, e.g. /mnt/share

string mount_path = 4;

Returns
TypeDescription
String

The mountPath.

getMountPathBytes()

public ByteString getMountPathBytes()

Mount path for the volume, e.g. /mnt/share

string mount_path = 4;

Returns
TypeDescription
ByteString

The bytes for mountPath.

getNfs()

public NFS getNfs()

An NFS source for the volume (could be a Filestore, for example).

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

Returns
TypeDescription
NFS

The nfs.

getNfsOrBuilder()

public NFSOrBuilder getNfsOrBuilder()

An NFS source for the volume (could be a Filestore, for example).

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

Returns
TypeDescription
NFSOrBuilder

getParserForType()

public Parser<Volume> getParserForType()
Returns
TypeDescription
Parser<Volume>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Volume.SourceCase getSourceCase()
Returns
TypeDescription
Volume.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDeviceName()

public boolean hasDeviceName()

Device name of an attached disk

string device_name = 6;

Returns
TypeDescription
boolean

Whether the deviceName field is set.

hasGcs()

public boolean hasGcs()

A Google Cloud Storage source for the volume.

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

Returns
TypeDescription
boolean

Whether the gcs field is set.

hasNfs()

public boolean hasNfs()

An NFS source for the volume (could be a Filestore, for example).

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

Returns
TypeDescription
boolean

Whether the nfs field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Volume.Builder newBuilderForType()
Returns
TypeDescription
Volume.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Volume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Volume.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Volume.Builder toBuilder()
Returns
TypeDescription
Volume.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException