Batch V1 API - Class Google::Cloud::Batch::V1::Volume (v0.21.0)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Volume.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#device_name

def device_name() -> ::String
Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: device_name, nfs, gcs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#device_name=

def device_name=(value) -> ::String
Parameter
  • value (::String) — 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.

    Note: The following fields are mutually exclusive: device_name, nfs, gcs. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: device_name, nfs, gcs. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs

def gcs() -> ::Google::Cloud::Batch::V1::GCS
Returns
  • (::Google::Cloud::Batch::V1::GCS) — A Google Cloud Storage (GCS) volume.

    Note: The following fields are mutually exclusive: gcs, nfs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs=

def gcs=(value) -> ::Google::Cloud::Batch::V1::GCS
Parameter
  • value (::Google::Cloud::Batch::V1::GCS) — A Google Cloud Storage (GCS) volume.

    Note: The following fields are mutually exclusive: gcs, nfs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Batch::V1::GCS) — A Google Cloud Storage (GCS) volume.

    Note: The following fields are mutually exclusive: gcs, nfs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mount_options

def mount_options() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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.

#mount_options=

def mount_options=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    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.
Returns
  • (::Array<::String>) —

    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.

#mount_path

def mount_path() -> ::String
Returns
  • (::String) — The mount path for the volume, e.g. /mnt/disks/share.

#mount_path=

def mount_path=(value) -> ::String
Parameter
  • value (::String) — The mount path for the volume, e.g. /mnt/disks/share.
Returns
  • (::String) — The mount path for the volume, e.g. /mnt/disks/share.

#nfs

def nfs() -> ::Google::Cloud::Batch::V1::NFS
Returns
  • (::Google::Cloud::Batch::V1::NFS) — A Network File System (NFS) volume. For example, a Filestore file share.

    Note: The following fields are mutually exclusive: nfs, gcs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#nfs=

def nfs=(value) -> ::Google::Cloud::Batch::V1::NFS
Parameter
  • value (::Google::Cloud::Batch::V1::NFS) — A Network File System (NFS) volume. For example, a Filestore file share.

    Note: The following fields are mutually exclusive: nfs, gcs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Batch::V1::NFS) — A Network File System (NFS) volume. For example, a Filestore file share.

    Note: The following fields are mutually exclusive: nfs, gcs, device_name. If a field in that set is populated, all other fields in the set will automatically be cleared.