Class Volume (0.8.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.v1alpha.Volume

Inheritance

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

Implements

VolumeOrBuilder

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

PD_FIELD_NUMBER

public static final int PD_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

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()

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
ByteString

The bytes for deviceName.

getGcs()

public GCS getGcs()

A Google Cloud Storage (GCS) volume.

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

Returns
Type Description
GCS

The gcs.

getGcsOrBuilder()

public GCSOrBuilder getGcsOrBuilder()

A Google Cloud Storage (GCS) volume.

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

Returns
Type Description
GCSOrBuilder

getMountOptions(int index)

public String getMountOptions(int index)

For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).

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)

For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).

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()

For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).

repeated string mount_options = 5;

Returns
Type Description
int

The count of mountOptions.

getMountOptionsList()

public ProtocolStringList getMountOptionsList()

For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).

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.v1alpha.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.v1alpha.NFS nfs = 1;

Returns
Type Description
NFSOrBuilder

getParserForType()

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

getPd() (deprecated)

public PD getPd()

Deprecated. google.cloud.batch.v1alpha.Volume.pd is deprecated. See google/cloud/batch/v1alpha/volume.proto;l=36

Deprecated: please use device_name instead.

.google.cloud.batch.v1alpha.PD pd = 2 [deprecated = true];

Returns
Type Description
PD

The pd.

getPdOrBuilder()

public PDOrBuilder getPdOrBuilder()

Deprecated: please use device_name instead.

.google.cloud.batch.v1alpha.PD pd = 2 [deprecated = true];

Returns
Type Description
PDOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public Volume.SourceCase getSourceCase()
Returns
Type Description
Volume.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasDeviceName()

public boolean hasDeviceName()

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
boolean

Whether the deviceName field is set.

hasGcs()

public boolean hasGcs()

A Google Cloud Storage (GCS) volume.

.google.cloud.batch.v1alpha.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.v1alpha.NFS nfs = 1;

Returns
Type Description
boolean

Whether the nfs field is set.

hasPd() (deprecated)

public boolean hasPd()

Deprecated. google.cloud.batch.v1alpha.Volume.pd is deprecated. See google/cloud/batch/v1alpha/volume.proto;l=36

Deprecated: please use device_name instead.

.google.cloud.batch.v1alpha.PD pd = 2 [deprecated = true];

Returns
Type Description
boolean

Whether the pd field is set.

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 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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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