Google Cloud Batch V1 Client - Class Disk (1.0.2)

Reference documentation and code samples for the Google Cloud Batch V1 Client class 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.

Generated from protobuf message google.cloud.batch.v1.AllocationPolicy.Disk

Namespace

Google \ Cloud \ Batch \ V1 \ AllocationPolicy

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ image string

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-cos: use Batch Container-Optimized images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
↳ snapshot string

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

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". If not specified, "pd-standard" will be used as the default type for non-boot disks, "pd-balanced" will be used as the default type for boot disks.
↳ size_gb int|string

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.
↳ disk_interface string

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.

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-cos: use Batch Container-Optimized images.
  • batch-hpc-rocky: use Batch HPC Rocky Linux images.
Returns
Type Description
string

hasImage

setImage

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-cos: use Batch Container-Optimized images.
  • batch-hpc-rocky: use Batch HPC Rocky Linux images.
Parameter
Name Description
var string
Returns
Type Description
$this

getSnapshot

Name of a snapshot used as the data source.

Snapshot is not supported as boot disk now.

Returns
Type Description
string

hasSnapshot

setSnapshot

Name of a snapshot used as the data source.

Snapshot is not supported as boot disk now.

Parameter
Name Description
var string
Returns
Type Description
$this

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". If not specified, "pd-standard" will be used as the default type for non-boot disks, "pd-balanced" will be used as the default type for boot disks.

Returns
Type Description
string

setType

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". If not specified, "pd-standard" will be used as the default type for non-boot disks, "pd-balanced" will be used as the default type for boot disks.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int|string

setSizeGb

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.

Parameter
Name Description
var int|string
Returns
Type Description
$this

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.

Returns
Type Description
string

setDiskInterface

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSource

Returns
Type Description
string