com.google.cloud.batch.v1

Class AllocationPolicy.InstancePolicyOrTemplate

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate

All Implemented Interfaces:

AllocationPolicy.InstancePolicyOrTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AllocationPolicy

public static final class AllocationPolicy.InstancePolicyOrTemplate
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllocationPolicy.InstancePolicyOrTemplate.Builder InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template.
static class	AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_PROJECT_SSH_KEYS_FIELD_NUMBER
static int	INSTALL_GPU_DRIVERS_FIELD_NUMBER
static int	INSTALL_OPS_AGENT_FIELD_NUMBER
static int	INSTANCE_TEMPLATE_FIELD_NUMBER
static int	POLICY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getBlockProjectSshKeys() Optional.
static AllocationPolicy.InstancePolicyOrTemplate	getDefaultInstance()
AllocationPolicy.InstancePolicyOrTemplate	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<AllocationPolicy.InstancePolicyOrTemplate>	getParserForType()
AllocationPolicy.InstancePolicy	getPolicy() InstancePolicy.
AllocationPolicy.InstancePolicyOrBuilder	getPolicyOrBuilder() InstancePolicy.
AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase	getPolicyTemplateCase()
int	getSerializedSize()
int	hashCode()
boolean	hasInstanceTemplate() Name of an instance template used to create VMs.
boolean	hasPolicy() InstancePolicy.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AllocationPolicy.InstancePolicyOrTemplate.Builder	newBuilder()
static AllocationPolicy.InstancePolicyOrTemplate.Builder	newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)
AllocationPolicy.InstancePolicyOrTemplate.Builder	newBuilderForType()
protected AllocationPolicy.InstancePolicyOrTemplate.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AllocationPolicy.InstancePolicyOrTemplate	parseDelimitedFrom(InputStream input)
static AllocationPolicy.InstancePolicyOrTemplate	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(byte[] data)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(ByteBuffer data)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(com.google.protobuf.ByteString data)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(com.google.protobuf.CodedInputStream input)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(InputStream input)
static AllocationPolicy.InstancePolicyOrTemplate	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AllocationPolicy.InstancePolicyOrTemplate>	parser()
AllocationPolicy.InstancePolicyOrTemplate.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER

See Also:

Constant Field Values

INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int INSTANCE_TEMPLATE_FIELD_NUMBER

See Also:

Constant Field Values

INSTALL_GPU_DRIVERS_FIELD_NUMBER

public static final int INSTALL_GPU_DRIVERS_FIELD_NUMBER

See Also:

Constant Field Values

INSTALL_OPS_AGENT_FIELD_NUMBER

public static final int INSTALL_OPS_AGENT_FIELD_NUMBER

See Also:

Constant Field Values

BLOCK_PROJECT_SSH_KEYS_FIELD_NUMBER

public static final int BLOCK_PROJECT_SSH_KEYS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPolicyTemplateCase

public AllocationPolicy.InstancePolicyOrTemplate.PolicyTemplateCase getPolicyTemplateCase()

Specified by:

getPolicyTemplateCase in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

hasPolicy

public boolean hasPolicy()

 InstancePolicy.
 

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

Specified by:

hasPolicy in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

Whether the policy field is set.

getPolicy

public AllocationPolicy.InstancePolicy getPolicy()

 InstancePolicy.
 

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

Specified by:

getPolicy in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

The policy.

getPolicyOrBuilder

public AllocationPolicy.InstancePolicyOrBuilder getPolicyOrBuilder()

 InstancePolicy.
 

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

Specified by:

getPolicyOrBuilder in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

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.

 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;

Specified by:

hasInstanceTemplate in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

Whether the instanceTemplate field is set.

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.

 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;

Specified by:

getInstanceTemplate in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

The instanceTemplate.

getInstanceTemplateBytes

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

Specified by:

getInstanceTemplateBytes in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

The bytes for instanceTemplate.

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;

Specified by:

getInstallGpuDrivers in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

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];

Specified by:

getInstallOpsAgent in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

The installOpsAgent.

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];

Specified by:

getBlockProjectSshKeys in interface AllocationPolicy.InstancePolicyOrTemplateOrBuilder

Returns:

The blockProjectSshKeys.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(ByteBuffer data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(com.google.protobuf.ByteString data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(com.google.protobuf.ByteString data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(byte[] data,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input)
                                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseDelimitedFrom(InputStream input,
                                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws IOException

Throws:

IOException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(com.google.protobuf.CodedInputStream input)
                                                           throws IOException

Throws:

IOException

parseFrom

public static AllocationPolicy.InstancePolicyOrTemplate parseFrom(com.google.protobuf.CodedInputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

newBuilderForType

public AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder()

newBuilder

public static AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilder(AllocationPolicy.InstancePolicyOrTemplate prototype)

toBuilder

public AllocationPolicy.InstancePolicyOrTemplate.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AllocationPolicy.InstancePolicyOrTemplate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AllocationPolicy.InstancePolicyOrTemplate getDefaultInstance()

parser

public static com.google.protobuf.Parser<AllocationPolicy.InstancePolicyOrTemplate> parser()

getParserForType

public com.google.protobuf.Parser<AllocationPolicy.InstancePolicyOrTemplate> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AllocationPolicy.InstancePolicyOrTemplate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder