Google Cloud Batch V1 Client - Class Disk (0.10.0)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ image string

Name of an image used as the data source. 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.

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

↳ size_gb int|string

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.

↳ 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. We only support "SCSI" for persistent disks now.

getImage

Name of an image used as the data source.

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.
Returns
TypeDescription
string

hasImage

setImage

Name of an image used as the data source.

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.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSnapshot

Name of a snapshot used as the data source.

Snapshot is not supported as boot disk now.

Returns
TypeDescription
string

hasSnapshot

setSnapshot

Name of a snapshot used as the data source.

Snapshot is not supported as boot disk now.

Parameter
NameDescription
var string
Returns
TypeDescription
$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".

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSizeGb

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.

Returns
TypeDescription
int|string

setSizeGb

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.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getDiskInterface

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.

Returns
TypeDescription
string

setDiskInterface

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataSource

Returns
TypeDescription
string