Interface AllocationPolicy.DiskOrBuilder (0.37.0)

public static interface AllocationPolicy.DiskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataSourceCase()

public abstract AllocationPolicy.Disk.DataSourceCase getDataSourceCase()
Returns
Type Description
AllocationPolicy.Disk.DataSourceCase

getDiskInterface()

public abstract String getDiskInterface()

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Returns
Type Description
String

The diskInterface.

getDiskInterfaceBytes()

public abstract ByteString getDiskInterfaceBytes()

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Returns
Type Description
ByteString

The bytes for diskInterface.

getImage()

public abstract String getImage()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}
  • Specify the image version: projects/{project}/global/images/{image_version}

    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.
  • batch-hpc-rocky: use Batch HPC Rocky Linux images.

string image = 4;

Returns
Type Description
String

The image.

getImageBytes()

public abstract ByteString getImageBytes()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}
  • Specify the image version: projects/{project}/global/images/{image_version}

    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.
  • batch-hpc-rocky: use Batch HPC Rocky Linux images.

string image = 4;

Returns
Type Description
ByteString

The bytes for image.

getSizeGb()

public abstract long getSizeGb()

Disk size in GB.

Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB.

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. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.

int64 size_gb = 2;

Returns
Type Description
long

The sizeGb.

getSnapshot()

public abstract String getSnapshot()

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

string snapshot = 5;

Returns
Type Description
String

The snapshot.

getSnapshotBytes()

public abstract ByteString getSnapshotBytes()

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

string snapshot = 5;

Returns
Type Description
ByteString

The bytes for snapshot.

getType()

public abstract String getType()

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

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

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

string type = 1;

Returns
Type Description
ByteString

The bytes for type.

hasImage()

public abstract boolean hasImage()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}
  • Specify the image version: projects/{project}/global/images/{image_version}

    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.
  • batch-hpc-rocky: use Batch HPC Rocky Linux images.

string image = 4;

Returns
Type Description
boolean

Whether the image field is set.

hasSnapshot()

public abstract boolean hasSnapshot()

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

string snapshot = 5;

Returns
Type Description
boolean

Whether the snapshot field is set.