com.google.cloud.batch.v1

Interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AllocationPolicy.InstancePolicyOrTemplate, AllocationPolicy.InstancePolicyOrTemplate.Builder

Enclosing class:

AllocationPolicy

public static interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getBlockProjectSshKeys() Optional.
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.
boolean	getInstallOpsAgent() Optional.
String	getInstanceTemplate() Name of an instance template used to create VMs.
com.google.protobuf.ByteString	getInstanceTemplateBytes() Name of an instance template used to create VMs.
AllocationPolicy.InstancePolicy	getPolicy() InstancePolicy.
AllocationPolicy.InstancePolicyOrBuilder	getPolicyOrBuilder() InstancePolicy.
AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase	getPolicyTemplateCase()
boolean	hasInstanceTemplate() Name of an instance template used to create VMs.
boolean	hasPolicy() InstancePolicy.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasPolicy

boolean hasPolicy()

 InstancePolicy.
 

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

Returns:

Whether the policy field is set.

getPolicy

AllocationPolicy.InstancePolicy getPolicy()

 InstancePolicy.
 

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

Returns:

The policy.

getPolicyOrBuilder

AllocationPolicy.InstancePolicyOrBuilder getPolicyOrBuilder()

 InstancePolicy.
 

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

hasInstanceTemplate

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.

 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.
 

string instance_template = 2;

Returns:

Whether the instanceTemplate field is set.

getInstanceTemplate

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.

 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.
 

string instance_template = 2;

Returns:

The instanceTemplate.

getInstanceTemplateBytes

com.google.protobuf.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.

 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.
 

string instance_template = 2;

Returns:

The bytes for instanceTemplate.

getInstallGpuDrivers

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:

The installGpuDrivers.

getInstallOpsAgent

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:

The installOpsAgent.

getBlockProjectSshKeys

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:

The blockProjectSshKeys.

getPolicyTemplateCase

AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase getPolicyTemplateCase()