Class AllocationPolicy (0.27.0) 

public final class AllocationPolicy extends 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.v1alpha.AllocationPolicy

Inheritance

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

Static Fields

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_TEMPLATES_FIELD_NUMBER

public static final int INSTANCE_TEMPLATES_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PLACEMENT_FIELD_NUMBER

public static final int PLACEMENT_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONING_MODELS_FIELD_NUMBER

public static final int PROVISIONING_MODELS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AllocationPolicy getDefaultInstance()
Returns
Type Description
AllocationPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(AllocationPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public AllocationPolicy getDefaultInstanceForType()
Returns
Type Description
AllocationPolicy

getInstance() (deprecated)

public AllocationPolicy.InstancePolicy getInstance()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance is deprecated. See google/cloud/batch/v1alpha/job.proto;l=559

Deprecated: please use instances[0].policy instead.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];

Returns
Type Description
AllocationPolicy.InstancePolicy

The instance.

getInstanceOrBuilder()

public AllocationPolicy.InstancePolicyOrBuilder getInstanceOrBuilder()

Deprecated: please use instances[0].policy instead.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];

Returns
Type Description
AllocationPolicy.InstancePolicyOrBuilder

getInstanceTemplates(int index) (deprecated)

public String getInstanceTemplates(int index)

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=566

Deprecated: please use instances[0].template instead.

repeated string instance_templates = 3 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instanceTemplates at the given index.

getInstanceTemplatesBytes(int index) (deprecated)

public ByteString getInstanceTemplatesBytes(int index)

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=566

Deprecated: please use instances[0].template instead.

repeated string instance_templates = 3 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instanceTemplates at the given index.

getInstanceTemplatesCount() (deprecated)

public int getInstanceTemplatesCount()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=566

Deprecated: please use instances[0].template instead.

repeated string instance_templates = 3 [deprecated = true];

Returns
Type Description
int

The count of instanceTemplates.

getInstanceTemplatesList() (deprecated)

public ProtocolStringList getInstanceTemplatesList()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=566

Deprecated: please use instances[0].template instead.

repeated string instance_templates = 3 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the instanceTemplates.

getInstances(int index)

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.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Parameter
Name Description
index int
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplate

getInstancesCount()

public int getInstancesCount()

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

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

Returns
Type Description
int

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.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Returns
Type Description
List<InstancePolicyOrTemplate>

getInstancesOrBuilder(int index)

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.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Parameter
Name Description
index int
Returns
Type Description
AllocationPolicy.InstancePolicyOrTemplateOrBuilder

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.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Returns
Type Description
List<? extends com.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplateOrBuilder>

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 6;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 6;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getLocation()

public AllocationPolicy.LocationPolicy getLocation()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;

Returns
Type Description
AllocationPolicy.LocationPolicy

The location.

getLocationOrBuilder()

public AllocationPolicy.LocationPolicyOrBuilder getLocationOrBuilder()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;

Returns
Type Description
AllocationPolicy.LocationPolicyOrBuilder

getNetwork()

public AllocationPolicy.NetworkPolicy getNetwork()

The network policy.

.google.cloud.batch.v1alpha.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type Description
AllocationPolicy.NetworkPolicy

The network.

getNetworkOrBuilder()

public AllocationPolicy.NetworkPolicyOrBuilder getNetworkOrBuilder()

The network policy.

.google.cloud.batch.v1alpha.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type Description
AllocationPolicy.NetworkPolicyOrBuilder

getParserForType()

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

getPlacement()

public AllocationPolicy.PlacementPolicy getPlacement()

The placement policy.

.google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type Description
AllocationPolicy.PlacementPolicy

The placement.

getPlacementOrBuilder()

public AllocationPolicy.PlacementPolicyOrBuilder getPlacementOrBuilder()

The placement policy.

.google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type Description
AllocationPolicy.PlacementPolicyOrBuilder

getProvisioningModels(int index) (deprecated)

public AllocationPolicy.ProvisioningModel getProvisioningModels(int index)

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=569

Deprecated: please use instances[0].policy.provisioning_model instead.

repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
AllocationPolicy.ProvisioningModel

The provisioningModels at the given index.

getProvisioningModelsCount() (deprecated)

public int getProvisioningModelsCount()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=569

Deprecated: please use instances[0].policy.provisioning_model instead.

repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];

Returns
Type Description
int

The count of provisioningModels.

getProvisioningModelsList() (deprecated)

public List<AllocationPolicy.ProvisioningModel> getProvisioningModelsList()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=569

Deprecated: please use instances[0].policy.provisioning_model instead.

repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];

Returns
Type Description
List<ProvisioningModel>

A list containing the provisioningModels.

getProvisioningModelsValue(int index) (deprecated)

public int getProvisioningModelsValue(int index)

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=569

Deprecated: please use instances[0].policy.provisioning_model instead.

repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of provisioningModels at the given index.

getProvisioningModelsValueList() (deprecated)

public List<Integer> getProvisioningModelsValueList()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=569

Deprecated: please use instances[0].policy.provisioning_model instead.

repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for provisioningModels.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public ServiceAccount getServiceAccount()

Service account that VMs will run as.

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

Returns
Type Description
ServiceAccount

The serviceAccount.

getServiceAccountEmail() (deprecated)

public String getServiceAccountEmail()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.service_account_email is deprecated. See google/cloud/batch/v1alpha/job.proto;l=572

Deprecated: please use service_account instead.

string service_account_email = 5 [deprecated = true];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes() (deprecated)

public ByteString getServiceAccountEmailBytes()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.service_account_email is deprecated. See google/cloud/batch/v1alpha/job.proto;l=572

Deprecated: please use service_account instead.

string service_account_email = 5 [deprecated = true];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getServiceAccountOrBuilder()

public ServiceAccountOrBuilder getServiceAccountOrBuilder()

Service account that VMs will run as.

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

Returns
Type Description
ServiceAccountOrBuilder

hasInstance() (deprecated)

public boolean hasInstance()

Deprecated. google.cloud.batch.v1alpha.AllocationPolicy.instance is deprecated. See google/cloud/batch/v1alpha/job.proto;l=559

Deprecated: please use instances[0].policy instead.

.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];

Returns
Type Description
boolean

Whether the instance field is set.

hasLocation()

public boolean hasLocation()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;

Returns
Type Description
boolean

Whether the location field is set.

hasNetwork()

public boolean hasNetwork()

The network policy.

.google.cloud.batch.v1alpha.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type Description
boolean

Whether the network field is set.

hasPlacement()

public boolean hasPlacement()

The placement policy.

.google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type Description
boolean

Whether the placement field is set.

hasServiceAccount()

public boolean hasServiceAccount()

Service account that VMs will run as.

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

Returns
Type Description
boolean

Whether the serviceAccount field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AllocationPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AllocationPolicy.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.Builder toBuilder()
Returns
Type Description
AllocationPolicy.Builder

writeTo(CodedOutputStream output)

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