Batch v1 API - Class AllocationPolicy.Types.Disk (2.3.0)

public sealed class AllocationPolicy.Types.Disk : IMessage<AllocationPolicy.Types.Disk>, IEquatable<AllocationPolicy.Types.Disk>, IDeepCloneable<AllocationPolicy.Types.Disk>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1 API class AllocationPolicy.Types.Disk.

A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.

Inheritance

object > AllocationPolicy.Types.Disk

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

Disk()

public Disk()

Disk(Disk)

public Disk(AllocationPolicy.Types.Disk other)
Parameter
NameDescription
otherAllocationPolicyTypesDisk

Properties

DataSourceCase

public AllocationPolicy.Types.Disk.DataSourceOneofCase DataSourceCase { get; }
Property Value
TypeDescription
AllocationPolicyTypesDiskDataSourceOneofCase

DiskInterface

public string DiskInterface { get; set; }

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.

Property Value
TypeDescription
string

HasImage

public bool HasImage { get; }

Gets whether the "image" field is set

Property Value
TypeDescription
bool

HasSnapshot

public bool HasSnapshot { get; }

Gets whether the "snapshot" field is set

Property Value
TypeDescription
bool

Image

public string Image { get; set; }

Name of an image used as the data source. For example, the following are all valid URLs:

  • Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>
  • Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.
Property Value
TypeDescription
string

SizeGb

public long SizeGb { get; set; }

Disk size in GB.

For persistent disk, this field is ignored if data_source is image or snapshot. For local SSD, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB. For boot disk, Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field.

Property Value
TypeDescription
long

Snapshot

public string Snapshot { get; set; }

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

Property Value
TypeDescription
string

Type

public string Type { get; set; }

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

Property Value
TypeDescription
string