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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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
Book disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. |
↳ 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. |
getMachineType
The Compute Engine machine type.
| Returns | |
|---|---|
| Type | Description |
string | |
setMachineType
The Compute Engine machine type.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinCpuPlatform
The minimum CPU platform.
See
https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
Not yet implemented.
| Returns | |
|---|---|
| Type | Description |
string | |
setMinCpuPlatform
The minimum CPU platform.
See
https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
Not yet implemented.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProvisioningModel
The provisioning model.
| Returns | |
|---|---|
| Type | Description |
int | |
setProvisioningModel
The provisioning model.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAccelerators
The accelerators attached to each VM instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAccelerators
The accelerators attached to each VM instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\AllocationPolicy\Accelerator>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBootDisk
Book disk to be created and attached to each VM by this InstancePolicy.
Boot disk will be deleted when the VM is deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\AllocationPolicy\Disk|null | |
hasBootDisk
clearBootDisk
setBootDisk
Book disk to be created and attached to each VM by this InstancePolicy.
Boot disk will be deleted when the VM is deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\AllocationPolicy\Disk
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Batch\V1\AllocationPolicy\AttachedDisk>
|
| Returns | |
|---|---|
| Type | Description |
$this | |