Google Cloud Batch V1 Client - Class InstancePolicy (0.12.1)

Reference documentation and code samples for the Google Cloud Batch V1 Client class InstancePolicy.

InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.

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

Namespace

Google \ Cloud \ Batch \ V1 \ AllocationPolicy

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ machine_type string

The Compute Engine machine type.

↳ min_cpu_platform string

The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

↳ provisioning_model int

The provisioning model.

↳ accelerators array<Google\Cloud\Batch\V1\AllocationPolicy\Accelerator>

The accelerators attached to each VM instance.

↳ boot_disk Google\Cloud\Batch\V1\AllocationPolicy\Disk

Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.

↳ disks array<Google\Cloud\Batch\V1\AllocationPolicy\AttachedDisk>

Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.

↳ reservation string

Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.

getMachineType

The Compute Engine machine type.

Returns
TypeDescription
string

setMachineType

The Compute Engine machine type.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMinCpuPlatform

Returns
TypeDescription
string

setMinCpuPlatform

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProvisioningModel

The provisioning model.

Returns
TypeDescription
int

setProvisioningModel

The provisioning model.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAccelerators

The accelerators attached to each VM instance.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAccelerators

The accelerators attached to each VM instance.

Parameter
NameDescription
var array<Google\Cloud\Batch\V1\AllocationPolicy\Accelerator>
Returns
TypeDescription
$this

getBootDisk

Boot disk to be created and attached to each VM by this InstancePolicy.

Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.

Returns
TypeDescription
Google\Cloud\Batch\V1\AllocationPolicy\Disk|null

hasBootDisk

clearBootDisk

setBootDisk

Boot disk to be created and attached to each VM by this InstancePolicy.

Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.

Parameter
NameDescription
var Google\Cloud\Batch\V1\AllocationPolicy\Disk
Returns
TypeDescription
$this

getDisks

Non-boot disks to be attached for each VM created by this InstancePolicy.

New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDisks

Non-boot disks to be attached for each VM created by this InstancePolicy.

New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.

Parameter
NameDescription
var array<Google\Cloud\Batch\V1\AllocationPolicy\AttachedDisk>
Returns
TypeDescription
$this

getReservation

Optional. If specified, VMs will consume only the specified reservation.

If not specified (default), VMs will consume any applicable reservation.

Returns
TypeDescription
string

setReservation

Optional. If specified, VMs will consume only the specified reservation.

If not specified (default), VMs will consume any applicable reservation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this