Package com.google.cloud.batch.v1alpha

Class Volume

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.batch.v1alpha.Volume
All Implemented Interfaces:
VolumeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Volume extends com.google.protobuf.GeneratedMessage implements VolumeOrBuilder
 Volume describes a volume and parameters for it to be mounted to a VM.
Protobuf type google.cloud.batch.v1alpha.Volume
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Volume.Builder
    Volume describes a volume and parameters for it to be mounted to a VM.
    static enum 
    Volume.SourceCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEVICE_NAME_FIELD_NUMBER
     
    static final int
    GCS_FIELD_NUMBER
     
    static final int
    MOUNT_OPTIONS_FIELD_NUMBER
     
    static final int
    MOUNT_PATH_FIELD_NUMBER
     
    static final int
    NFS_FIELD_NUMBER
     
    static final int
    PD_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Volume
    getDefaultInstance()
     
    Volume
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.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.
    GCS
    getGcs()
    A Google Cloud Storage (GCS) volume.
    GCSOrBuilder
    getGcsOrBuilder()
    A Google Cloud Storage (GCS) volume.
    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](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported
    com.google.protobuf.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](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported
    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](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported
    com.google.protobuf.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](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported
    String
    getMountPath()
    The mount path for the volume, e.g.
    com.google.protobuf.ByteString
    getMountPathBytes()
    The mount path for the volume, e.g.
    NFS
    getNfs()
    A Network File System (NFS) volume.
    NFSOrBuilder
    getNfsOrBuilder()
    A Network File System (NFS) volume.
    com.google.protobuf.Parser<Volume>
    getParserForType()
     
    PD
    getPd()
    Deprecated.
    google.cloud.batch.v1alpha.Volume.pd is deprecated.
    PDOrBuilder
    getPdOrBuilder()
    Deprecated.
    int
    getSerializedSize()
     
    Volume.SourceCase
    getSourceCase()
     
    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.
    boolean
    hasGcs()
    A Google Cloud Storage (GCS) volume.
    int
    hashCode()
     
    boolean
    hasNfs()
    A Network File System (NFS) volume.
    boolean
    hasPd()
    Deprecated.
    google.cloud.batch.v1alpha.Volume.pd is deprecated.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Volume.Builder
    newBuilder()
     
    static Volume.Builder
    newBuilder(Volume prototype)
     
    Volume.Builder
    newBuilderForType()
     
    protected Volume.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Volume
    parseDelimitedFrom(InputStream input)
     
    static Volume
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Volume
    parseFrom(byte[] data)
     
    static Volume
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Volume
    parseFrom(com.google.protobuf.ByteString data)
     
    static Volume
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Volume
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Volume
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Volume
    parseFrom(InputStream input)
     
    static Volume
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Volume
    parseFrom(ByteBuffer data)
     
    static Volume
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Volume>
    parser()
     
    Volume.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSourceCase

      public Volume.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface VolumeOrBuilder

    • hasNfs

      public boolean hasNfs()
       A Network File System (NFS) volume. For example, a
 Filestore file share.
      .google.cloud.batch.v1alpha.NFS nfs = 1;
      Specified by:
      hasNfs in interface VolumeOrBuilder
      Returns:
      Whether the nfs field is set.

    • getNfs

      public NFS getNfs()
       A Network File System (NFS) volume. For example, a
 Filestore file share.
      .google.cloud.batch.v1alpha.NFS nfs = 1;
      Specified by:
      getNfs in interface VolumeOrBuilder
      Returns:
      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;
      Specified by:
      getNfsOrBuilder in interface VolumeOrBuilder

    • 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];
      Specified by:
      hasPd in interface VolumeOrBuilder
      Returns:
      Whether the pd field is set.

    • 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];
      Specified by:
      getPd in interface VolumeOrBuilder
      Returns:
      The pd.

    • getPdOrBuilder

      @Deprecated public PDOrBuilder getPdOrBuilder()
      Deprecated.
       Deprecated: please use device_name instead.
      .google.cloud.batch.v1alpha.PD pd = 2 [deprecated = true];
      Specified by:
      getPdOrBuilder in interface VolumeOrBuilder

    • hasGcs

      public boolean hasGcs()
       A Google Cloud Storage (GCS) volume.
      .google.cloud.batch.v1alpha.GCS gcs = 3;
      Specified by:
      hasGcs in interface VolumeOrBuilder
      Returns:
      Whether the gcs field is set.

    • getGcs

      public GCS getGcs()
       A Google Cloud Storage (GCS) volume.
      .google.cloud.batch.v1alpha.GCS gcs = 3;
      Specified by:
      getGcs in interface VolumeOrBuilder
      Returns:
      The gcs.

    • getGcsOrBuilder

      public GCSOrBuilder getGcsOrBuilder()
       A Google Cloud Storage (GCS) volume.
      .google.cloud.batch.v1alpha.GCS gcs = 3;
      Specified by:
      getGcsOrBuilder in interface VolumeOrBuilder

    • 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;
      Specified by:
      hasDeviceName in interface VolumeOrBuilder
      Returns:
      Whether the deviceName field is set.

    • 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;
      Specified by:
      getDeviceName in interface VolumeOrBuilder
      Returns:
      The deviceName.

    • getDeviceNameBytes

      public com.google.protobuf.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;
      Specified by:
      getDeviceNameBytes in interface VolumeOrBuilder
      Returns:
      The bytes for deviceName.

    • getMountPath

      public String getMountPath()
       The mount path for the volume, e.g. /mnt/disks/share.
      string mount_path = 4;
      Specified by:
      getMountPath in interface VolumeOrBuilder
      Returns:
      The mountPath.

    • getMountPathBytes

      public com.google.protobuf.ByteString getMountPathBytes()
       The mount path for the volume, e.g. /mnt/disks/share.
      string mount_path = 4;
      Specified by:
      getMountPathBytes in interface VolumeOrBuilder
      Returns:
      The bytes for mountPath.

    • getMountOptionsList

      public com.google.protobuf.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](https://cloud.google.com/storage/docs/gcsfuse-cli)
 are supported.
 * For an existing persistent disk, all 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 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;
      Specified by:
      getMountOptionsList in interface VolumeOrBuilder
      Returns:
      A list containing the mountOptions.

    • 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](https://cloud.google.com/storage/docs/gcsfuse-cli)
 are supported.
 * For an existing persistent disk, all 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 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;
      Specified by:
      getMountOptionsCount in interface VolumeOrBuilder
      Returns:
      The count of mountOptions.

    • getMountOptions

      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](https://cloud.google.com/storage/docs/gcsfuse-cli)
 are supported.
 * For an existing persistent disk, all 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 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;
      Specified by:
      getMountOptions in interface VolumeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The mountOptions at the given index.

    • getMountOptionsBytes

      public com.google.protobuf.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](https://cloud.google.com/storage/docs/gcsfuse-cli)
 are supported.
 * For an existing persistent disk, all 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 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;
      Specified by:
      getMountOptionsBytes in interface VolumeOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the mountOptions at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Volume parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Volume parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Volume parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Volume parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Volume parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Volume parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Volume parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Volume.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Volume.Builder newBuilder()

    • newBuilder

      public static Volume.Builder newBuilder(Volume prototype)

    • toBuilder

      public Volume.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Volume.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Volume getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Volume> parser()

    • getParserForType

      public com.google.protobuf.Parser<Volume> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Volume getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder