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 \ AllocationPolicyMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ policy |
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. Batch only supports global instance templates from the same project as the job. You can specify the global instance template as a full or partial URL. |
↳ 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 |
↳ install_ops_agent |
bool
Optional. Set this field true if you want Batch to install Ops Agent on your behalf. Default is false. |
↳ block_project_ssh_keys |
bool
Optional. Set this field to |
getPolicy
InstancePolicy.
| Returns | |
|---|---|
| Type | Description |
InstancePolicy|null |
|
hasPolicy
setPolicy
InstancePolicy.
| Parameter | |
|---|---|
| Name | Description |
var |
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. Batch only supports global instance templates from the same project as the job. You can specify the global instance template as a full or partial URL.
| 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. Batch only supports global instance templates from the same project as the job. You can specify the global instance template as a full or partial URL.
| 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 |
|
getBlockProjectSshKeys
Optional. Set this field to true if you want Batch to block
project-level SSH keys from accessing this job's VMs. Alternatively, you
can configure the job to specify a VM instance template that blocks
project-level SSH keys. In either case, Batch blocks project-level SSH
keys while creating the VMs for this job.
Batch allows project-level SSH keys for a job's VMs only if all the following are true:
- This field is undefined or set to
false. - The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys
| Returns | |
|---|---|
| Type | Description |
bool |
|
setBlockProjectSshKeys
Optional. Set this field to true if you want Batch to block
project-level SSH keys from accessing this job's VMs. Alternatively, you
can configure the job to specify a VM instance template that blocks
project-level SSH keys. In either case, Batch blocks project-level SSH
keys while creating the VMs for this job.
Batch allows project-level SSH keys for a job's VMs only if all the following are true:
- This field is undefined or set to
false. - The job's VM instance template (if any) doesn't block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPolicyTemplate
| Returns | |
|---|---|
| Type | Description |
string |
|