Class AllocationPolicy.InstancePolicyOrTemplate.Builder (0.41.0)

public static final class AllocationPolicy.InstancePolicyOrTemplate.Builder extends GeneratedMessageV3.Builder<AllocationPolicy.InstancePolicyOrTemplate.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

build()

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

buildPartial()

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

clear()

public AllocationPolicy.InstancePolicyOrTemplate.Builder clear()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AllocationPolicy.InstancePolicyOrTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

clearInstallGpuDrivers()

public AllocationPolicy.InstancePolicyOrTemplate.Builder clearInstallGpuDrivers()

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
AllocationPolicy.InstancePolicyOrTemplate.Builder

This builder for chaining.

clearInstanceTemplate()

public AllocationPolicy.InstancePolicyOrTemplate.Builder clearInstanceTemplate()

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
AllocationPolicy.InstancePolicyOrTemplate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AllocationPolicy.InstancePolicyOrTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

clearPolicy()

public AllocationPolicy.InstancePolicyOrTemplate.Builder clearPolicy()

InstancePolicy.

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

Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

clearPolicyTemplate()

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

clone()

public AllocationPolicy.InstancePolicyOrTemplate.Builder clone()
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getPolicy()

public AllocationPolicy.InstancePolicy getPolicy()

InstancePolicy.

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

Returns
TypeDescription
AllocationPolicy.InstancePolicy

The policy.

getPolicyBuilder()

public AllocationPolicy.InstancePolicy.Builder getPolicyBuilder()

InstancePolicy.

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

Returns
TypeDescription
AllocationPolicy.InstancePolicy.Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AllocationPolicy.InstancePolicyOrTemplate other)

public AllocationPolicy.InstancePolicyOrTemplate.Builder mergeFrom(AllocationPolicy.InstancePolicyOrTemplate other)
Parameter
NameDescription
otherAllocationPolicy.InstancePolicyOrTemplate
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AllocationPolicy.InstancePolicyOrTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AllocationPolicy.InstancePolicyOrTemplate.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

mergePolicy(AllocationPolicy.InstancePolicy value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder mergePolicy(AllocationPolicy.InstancePolicy value)

InstancePolicy.

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

Parameter
NameDescription
valueAllocationPolicy.InstancePolicy
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AllocationPolicy.InstancePolicyOrTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

setInstallGpuDrivers(boolean value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setInstallGpuDrivers(boolean value)

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;

Parameter
NameDescription
valueboolean

The installGpuDrivers to set.

Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

This builder for chaining.

setInstanceTemplate(String value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setInstanceTemplate(String value)

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;

Parameter
NameDescription
valueString

The instanceTemplate to set.

Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

This builder for chaining.

setInstanceTemplateBytes(ByteString value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setInstanceTemplateBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for instanceTemplate to set.

Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

This builder for chaining.

setPolicy(AllocationPolicy.InstancePolicy value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setPolicy(AllocationPolicy.InstancePolicy value)

InstancePolicy.

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

Parameter
NameDescription
valueAllocationPolicy.InstancePolicy
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

setPolicy(AllocationPolicy.InstancePolicy.Builder builderForValue)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setPolicy(AllocationPolicy.InstancePolicy.Builder builderForValue)

InstancePolicy.

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

Parameter
NameDescription
builderForValueAllocationPolicy.InstancePolicy.Builder
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AllocationPolicy.InstancePolicyOrTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AllocationPolicy.InstancePolicyOrTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AllocationPolicy.InstancePolicyOrTemplate.Builder
Overrides