Class AllocationPolicy.InstancePolicyOrTemplate (0.51.0)

public static final class AllocationPolicy.InstancePolicyOrTemplate extends GeneratedMessageV3 implements AllocationPolicy.InstancePolicyOrTemplateOrBuilder

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.

Protobuf type google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AllocationPolicy.InstancePolicyOrTemplate

Static Fields

BLOCK_PROJECT_SSH_KEYS_FIELD_NUMBER

public static final int BLOCK_PROJECT_SSH_KEYS_FIELD_NUMBER
Field Value
Type Description
int

INSTALL_GPU_DRIVERS_FIELD_NUMBER

public static final int INSTALL_GPU_DRIVERS_FIELD_NUMBER
Field Value
Type Description
int

INSTALL_OPS_AGENT_FIELD_NUMBER

public static final int INSTALL_OPS_AGENT_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int INSTANCE_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AllocationPolicy.InstancePolicyOrTemplate getDefaultInstance()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.Builder

newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)
Parameter
Name Description
prototype AllocationPolicy.InstancePolicyOrTemplate
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.Builder

parseDelimitedFrom(InputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AllocationPolicy.InstancePolicyOrTemplate> parser()
Returns
Type Description
Parser<InstancePolicyOrTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBlockProjectSshKeys()

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

getDefaultInstanceForType()

public AllocationPolicy.InstancePolicyOrTemplate getDefaultInstanceForType()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate

getInstallGpuDrivers()

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

getParserForType()

public Parser<AllocationPolicy.InstancePolicyOrTemplate> getParserForType()
Returns
Type Description
Parser<InstancePolicyOrTemplate>
Overrides

getPolicy()

public AllocationPolicy.InstancePolicy getPolicy()

InstancePolicy.

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

Returns
Type Description
AllocationPolicy.InstancePolicy

The policy.

getPolicyOrBuilder()

public AllocationPolicy.InstancePolicyOrBuilder getPolicyOrBuilder()

InstancePolicy.

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

Returns
Type Description
AllocationPolicy.InstancePolicyOrBuilder

getPolicyTemplateCase()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasInstanceTemplate()

public 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 boolean hasPolicy()

InstancePolicy.

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

Returns
Type Description
boolean

Whether the policy field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AllocationPolicy.InstancePolicyOrTemplate.Builder toBuilder()
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException