Interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder (0.53.0) 

public static interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBlockProjectSshKeys()

public abstract boolean 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

bool block_project_ssh_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The blockProjectSshKeys.

getInstallGpuDrivers()

public abstract boolean 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.

bool install_gpu_drivers = 3;

Returns
Type Description
boolean

The installGpuDrivers.

getInstallOpsAgent()

public abstract boolean getInstallOpsAgent()

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

bool install_ops_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The installOpsAgent.

getInstanceTemplate()

public abstract String getInstanceTemplate()

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

string instance_template = 2;

Returns
Type Description
String

The instanceTemplate.

getInstanceTemplateBytes()

public abstract ByteString getInstanceTemplateBytes()

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

string instance_template = 2;

Returns
Type Description
ByteString

The bytes for instanceTemplate.

getPolicy()

public abstract AllocationPolicy.InstancePolicy getPolicy()

InstancePolicy.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy policy = 1;

Returns
Type Description
AllocationPolicy.InstancePolicy

The policy.

getPolicyOrBuilder()

public abstract AllocationPolicy.InstancePolicyOrBuilder getPolicyOrBuilder()

InstancePolicy.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy policy = 1;

Returns
Type Description
AllocationPolicy.InstancePolicyOrBuilder

getPolicyTemplateCase()

public abstract AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase getPolicyTemplateCase()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase

hasInstanceTemplate()

public abstract boolean hasInstanceTemplate()

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

string instance_template = 2;

Returns
Type Description
boolean

Whether the instanceTemplate field is set.

hasPolicy()

public abstract boolean hasPolicy()

InstancePolicy.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy policy = 1;

Returns
Type Description
boolean

Whether the policy field is set.