Class AllocationPolicy.InstancePolicyOrTemplate (0.41.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

INSTALL_GPU_DRIVERS_FIELD_NUMBER

public static final int INSTALL_GPU_DRIVERS_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int INSTANCE_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AllocationPolicy.InstancePolicyOrTemplate getDefaultInstance()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)
Parameter
NameDescription
prototypeAllocationPolicy.InstancePolicyOrTemplate
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

parseDelimitedFrom(InputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AllocationPolicy.InstancePolicyOrTemplate getDefaultInstanceForType()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate

getInstallGpuDrivers()

public boolean getInstallGpuDrivers()

Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their 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
TypeDescription
boolean

The installGpuDrivers.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for instanceTemplate.

getParserForType()

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

getPolicy()

public AllocationPolicy.InstancePolicy getPolicy()

InstancePolicy.

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

Returns
TypeDescription
AllocationPolicy.InstancePolicy

The policy.

getPolicyOrBuilder()

public AllocationPolicy.InstancePolicyOrBuilder getPolicyOrBuilder()

InstancePolicy.

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

Returns
TypeDescription
AllocationPolicy.InstancePolicyOrBuilder

getPolicyTemplateCase()

public AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase getPolicyTemplateCase()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the instanceTemplate field is set.

hasPolicy()

public boolean hasPolicy()

InstancePolicy.

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

Returns
TypeDescription
boolean

Whether the policy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AllocationPolicy.InstancePolicyOrTemplate.Builder toBuilder()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException