AllocationPolicy (proto-google-cloud-batch-v1 0.81.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.batch.v1.AllocationPolicy

All Implemented Interfaces:

AllocationPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class AllocationPolicy
extends com.google.protobuf.GeneratedMessageV3
implements AllocationPolicyOrBuilder
```
```
 A Job's resource allocation policy describes when, where, and how compute
 resources should be allocated for the Job.
 
```
Protobuf type google.cloud.batch.v1.AllocationPolicy
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AllocationPolicy.Accelerator` Accelerator describes Compute Engine accelerators to be attached to the VM.
`static interface`	`AllocationPolicy.AcceleratorOrBuilder`
`static class`	`AllocationPolicy.AttachedDisk` A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
`static interface`	`AllocationPolicy.AttachedDiskOrBuilder`
`static class`	`AllocationPolicy.Builder` A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
`static class`	`AllocationPolicy.Disk` A new persistent disk or a local ssd.
`static interface`	`AllocationPolicy.DiskOrBuilder`
`static class`	`AllocationPolicy.InstancePolicy` InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
`static interface`	`AllocationPolicy.InstancePolicyOrBuilder`
`static class`	`AllocationPolicy.InstancePolicyOrTemplate` InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template.
`static interface`	`AllocationPolicy.InstancePolicyOrTemplateOrBuilder`
`static class`	`AllocationPolicy.LocationPolicy` Protobuf type `google.cloud.batch.v1.AllocationPolicy.LocationPolicy`
`static interface`	`AllocationPolicy.LocationPolicyOrBuilder`
`static class`	`AllocationPolicy.NetworkInterface` A network interface.
`static interface`	`AllocationPolicy.NetworkInterfaceOrBuilder`
`static class`	`AllocationPolicy.NetworkPolicy` NetworkPolicy describes VM instance network configurations.
`static interface`	`AllocationPolicy.NetworkPolicyOrBuilder`
`static class`	`AllocationPolicy.PlacementPolicy` PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
`static interface`	`AllocationPolicy.PlacementPolicyOrBuilder`
`static class`	`AllocationPolicy.ProvisioningModel` Compute Engine VM instance provisioning model.

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`	`INSTANCES_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`LOCATION_FIELD_NUMBER`
`static int`	`NETWORK_FIELD_NUMBER`
`static int`	`PLACEMENT_FIELD_NUMBER`
`static int`	`SERVICE_ACCOUNT_FIELD_NUMBER`
`static int`	`TAGS_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
`boolean`	`equals(Object obj)`
`static AllocationPolicy`	`getDefaultInstance()`
`AllocationPolicy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`AllocationPolicy.InstancePolicyOrTemplate`	`getInstances(int index)` Describe instances that can be created by this AllocationPolicy.
`int`	`getInstancesCount()` Describe instances that can be created by this AllocationPolicy.
`List<AllocationPolicy.InstancePolicyOrTemplate>`	`getInstancesList()` Describe instances that can be created by this AllocationPolicy.
`AllocationPolicy.InstancePolicyOrTemplateOrBuilder`	`getInstancesOrBuilder(int index)` Describe instances that can be created by this AllocationPolicy.
`List<? extends AllocationPolicy.InstancePolicyOrTemplateOrBuilder>`	`getInstancesOrBuilderList()` Describe instances that can be created by this AllocationPolicy.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
`Map<String,String>`	`getLabelsMap()` Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
`String`	`getLabelsOrThrow(String key)` Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels.
`AllocationPolicy.LocationPolicy`	`getLocation()` Location where compute resources should be allocated for the Job.
`AllocationPolicy.LocationPolicyOrBuilder`	`getLocationOrBuilder()` Location where compute resources should be allocated for the Job.
`AllocationPolicy.NetworkPolicy`	`getNetwork()` The network policy.
`AllocationPolicy.NetworkPolicyOrBuilder`	`getNetworkOrBuilder()` The network policy.
`com.google.protobuf.Parser<AllocationPolicy>`	`getParserForType()`
`AllocationPolicy.PlacementPolicy`	`getPlacement()` The placement policy.
`AllocationPolicy.PlacementPolicyOrBuilder`	`getPlacementOrBuilder()` The placement policy.
`int`	`getSerializedSize()`
`ServiceAccount`	`getServiceAccount()` Defines the service account for Batch-created VMs.
`ServiceAccountOrBuilder`	`getServiceAccountOrBuilder()` Defines the service account for Batch-created VMs.
`String`	`getTags(int index)` Optional.
`com.google.protobuf.ByteString`	`getTagsBytes(int index)` Optional.
`int`	`getTagsCount()` Optional.
`com.google.protobuf.ProtocolStringList`	`getTagsList()` Optional.
`int`	`hashCode()`
`boolean`	`hasLocation()` Location where compute resources should be allocated for the Job.
`boolean`	`hasNetwork()` The network policy.
`boolean`	`hasPlacement()` The placement policy.
`boolean`	`hasServiceAccount()` Defines the service account for Batch-created VMs.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static AllocationPolicy.Builder`	`newBuilder()`
`static AllocationPolicy.Builder`	`newBuilder(AllocationPolicy prototype)`
`AllocationPolicy.Builder`	`newBuilderForType()`
`protected AllocationPolicy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static AllocationPolicy`	`parseDelimitedFrom(InputStream input)`
`static AllocationPolicy`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AllocationPolicy`	`parseFrom(byte[] data)`
`static AllocationPolicy`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AllocationPolicy`	`parseFrom(ByteBuffer data)`
`static AllocationPolicy`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AllocationPolicy`	`parseFrom(com.google.protobuf.ByteString data)`
`static AllocationPolicy`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AllocationPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static AllocationPolicy`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AllocationPolicy`	`parseFrom(InputStream input)`
`static AllocationPolicy`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<AllocationPolicy>`	`parser()`
`AllocationPolicy.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, 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
- LOCATION_FIELD_NUMBER
```
public static final int LOCATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INSTANCES_FIELD_NUMBER
```
public static final int INSTANCES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_ACCOUNT_FIELD_NUMBER
```
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NETWORK_FIELD_NUMBER
```
public static final int NETWORK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PLACEMENT_FIELD_NUMBER
```
public static final int PLACEMENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TAGS_FIELD_NUMBER
```
public static final int TAGS_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()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasLocation
```
public boolean hasLocation()
```
```
 Location where compute resources should be allocated for the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;
Specified by:

hasLocation in interface AllocationPolicyOrBuilder

Returns:

Whether the location field is set.

getLocation
```
public AllocationPolicy.LocationPolicy getLocation()
```
```
 Location where compute resources should be allocated for the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;
Specified by:

getLocation in interface AllocationPolicyOrBuilder

Returns:

The location.

getLocationOrBuilder
```
public AllocationPolicy.LocationPolicyOrBuilder getLocationOrBuilder()
```
```
 Location where compute resources should be allocated for the Job.
 
```
.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;
Specified by:

getLocationOrBuilder in interface AllocationPolicyOrBuilder

getInstancesList

public List<AllocationPolicy.InstancePolicyOrTemplate> getInstancesList()

 Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Specified by:: getInstancesList in interface AllocationPolicyOrBuilder

getInstancesOrBuilderList

public List<? extends AllocationPolicy.InstancePolicyOrTemplateOrBuilder> getInstancesOrBuilderList()

 Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Specified by:: getInstancesOrBuilderList in interface AllocationPolicyOrBuilder

getInstancesCount
```
public int getInstancesCount()
```
```
 Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
 
```
repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;
Specified by:

getInstancesCount in interface AllocationPolicyOrBuilder

getInstances

public AllocationPolicy.InstancePolicyOrTemplate getInstances(int index)

 Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Specified by:: getInstances in interface AllocationPolicyOrBuilder

getInstancesOrBuilder

public AllocationPolicy.InstancePolicyOrTemplateOrBuilder getInstancesOrBuilder(int index)

 Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Specified by:: getInstancesOrBuilder in interface AllocationPolicyOrBuilder

hasServiceAccount

public boolean hasServiceAccount()

 Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used. Must match the service account specified in any used instance
 template configured in the Batch job.

 Includes the following fields:
  * email: The service account's email address. If not set, the default
  Compute Engine service account is used.
  * scopes: Additional OAuth scopes to grant the service account, beyond the
  default cloud-platform scope. (list of strings)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Specified by:: hasServiceAccount in interface AllocationPolicyOrBuilder
Returns:: Whether the serviceAccount field is set.

getServiceAccount

public ServiceAccount getServiceAccount()

 Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used. Must match the service account specified in any used instance
 template configured in the Batch job.

 Includes the following fields:
  * email: The service account's email address. If not set, the default
  Compute Engine service account is used.
  * scopes: Additional OAuth scopes to grant the service account, beyond the
  default cloud-platform scope. (list of strings)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Specified by:: getServiceAccount in interface AllocationPolicyOrBuilder
Returns:: The serviceAccount.

getServiceAccountOrBuilder

public ServiceAccountOrBuilder getServiceAccountOrBuilder()

 Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used. Must match the service account specified in any used instance
 template configured in the Batch job.

 Includes the following fields:
  * email: The service account's email address. If not set, the default
  Compute Engine service account is used.
  * scopes: Additional OAuth scopes to grant the service account, beyond the
  default cloud-platform scope. (list of strings)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Specified by:: getServiceAccountOrBuilder in interface AllocationPolicyOrBuilder