Google Cloud Batch V1 Client - Class InstancePolicyOrTemplate (1.0.3)

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

InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template.

If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.

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

Namespace

Google \ Cloud \ Batch \ V1 \ AllocationPolicy

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ policy Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicy

InstancePolicy.
↳ instance_template string

Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
↳ install_gpu_drivers bool

Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
↳ install_ops_agent bool

Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

getPolicy

InstancePolicy.

Returns
Type Description
Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicy|null

hasPolicy

setPolicy

InstancePolicy.

Parameter
Name Description
var Google\Cloud\Batch\V1\AllocationPolicy\InstancePolicy
Returns
Type Description
$this

getInstanceTemplate

Name of an instance template used to create VMs.

Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.

Returns
Type Description
string

hasInstanceTemplate

setInstanceTemplate

Name of an instance template used to create VMs.

Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstallGpuDrivers

Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false.

For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

Returns
Type Description
bool

setInstallGpuDrivers

Set this field true if you want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on your behalf. Default is false.

For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.

Parameter
Name Description
var bool
Returns
Type Description
$this

getInstallOpsAgent

Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

Returns
Type Description
bool

setInstallOpsAgent

Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPolicyTemplate

Returns
Type Description
string