Class AllocationPolicy.Builder (0.37.0)

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

Static Methods

getDescriptor()

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

Methods

addAllInstanceTemplates(Iterable<String> values) (deprecated)

public AllocationPolicy.Builder addAllInstanceTemplates(Iterable<String> values)

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

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

repeated string instance_templates = 3 [deprecated = true];

Parameter
Name Description
values Iterable<String>

The instanceTemplates to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addAllInstances(Iterable<? extends AllocationPolicy.InstancePolicyOrTemplate> values)

public AllocationPolicy.Builder addAllInstances(Iterable<? extends AllocationPolicy.InstancePolicyOrTemplate> values)

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
values Iterable<? extends com.google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate>
Returns
Type Description
AllocationPolicy.Builder

addAllProvisioningModels(Iterable<? extends AllocationPolicy.ProvisioningModel> values) (deprecated)

public AllocationPolicy.Builder addAllProvisioningModels(Iterable<? extends AllocationPolicy.ProvisioningModel> values)

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

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel>

The provisioningModels to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addAllProvisioningModelsValue(Iterable<Integer> values) (deprecated)

public AllocationPolicy.Builder addAllProvisioningModelsValue(Iterable<Integer> values)

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

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

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for provisioningModels to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addAllTags(Iterable<String> values)

public AllocationPolicy.Builder addAllTags(Iterable<String> values)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The tags to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addInstanceTemplates(String value) (deprecated)

public AllocationPolicy.Builder addInstanceTemplates(String value)

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

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

repeated string instance_templates = 3 [deprecated = true];

Parameter
Name Description
value String

The instanceTemplates to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addInstanceTemplatesBytes(ByteString value) (deprecated)

public AllocationPolicy.Builder addInstanceTemplatesBytes(ByteString value)

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

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

repeated string instance_templates = 3 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes of the instanceTemplates to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addInstances(AllocationPolicy.InstancePolicyOrTemplate value)

public AllocationPolicy.Builder addInstances(AllocationPolicy.InstancePolicyOrTemplate value)

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
value AllocationPolicy.InstancePolicyOrTemplate
Returns
Type Description
AllocationPolicy.Builder

addInstances(AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

public AllocationPolicy.Builder addInstances(AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

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
builderForValue AllocationPolicy.InstancePolicyOrTemplate.Builder
Returns
Type Description
AllocationPolicy.Builder

addInstances(int index, AllocationPolicy.InstancePolicyOrTemplate value)

public AllocationPolicy.Builder addInstances(int index, AllocationPolicy.InstancePolicyOrTemplate value)

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

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

Parameters
Name Description
index int
value AllocationPolicy.InstancePolicyOrTemplate
Returns
Type Description
AllocationPolicy.Builder

addInstances(int index, AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

public AllocationPolicy.Builder addInstances(int index, AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AllocationPolicy.InstancePolicyOrTemplate.Builder
Returns
Type Description
AllocationPolicy.Builder

addInstancesBuilder()

public AllocationPolicy.InstancePolicyOrTemplate.Builder addInstancesBuilder()

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

addInstancesBuilder(int index)

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

addProvisioningModels(AllocationPolicy.ProvisioningModel value) (deprecated)

public AllocationPolicy.Builder addProvisioningModels(AllocationPolicy.ProvisioningModel value)

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

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

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

Parameter
Name Description
value AllocationPolicy.ProvisioningModel

The provisioningModels to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addProvisioningModelsValue(int value) (deprecated)

public AllocationPolicy.Builder addProvisioningModelsValue(int value)

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

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for provisioningModels to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AllocationPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AllocationPolicy.Builder
Overrides

addTags(String value)

public AllocationPolicy.Builder addTags(String value)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The tags to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public AllocationPolicy.Builder addTagsBytes(ByteString value)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the tags to add.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

build()

public AllocationPolicy build()
Returns
Type Description
AllocationPolicy

buildPartial()

public AllocationPolicy buildPartial()
Returns
Type Description
AllocationPolicy

clear()

public AllocationPolicy.Builder clear()
Returns
Type Description
AllocationPolicy.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AllocationPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AllocationPolicy.Builder
Overrides

clearInstance() (deprecated)

public AllocationPolicy.Builder clearInstance()

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

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

Returns
Type Description
AllocationPolicy.Builder

clearInstanceTemplates() (deprecated)

public AllocationPolicy.Builder clearInstanceTemplates()

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

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

repeated string instance_templates = 3 [deprecated = true];

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

clearInstances()

public AllocationPolicy.Builder clearInstances()

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

clearLabels()

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

clearLocation()

public AllocationPolicy.Builder clearLocation()

Location where compute resources should be allocated for the Job.

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

Returns
Type Description
AllocationPolicy.Builder

clearNetwork()

public AllocationPolicy.Builder clearNetwork()

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Returns
Type Description
AllocationPolicy.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AllocationPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AllocationPolicy.Builder
Overrides

clearPlacement()

public AllocationPolicy.Builder clearPlacement()

The placement policy.

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

Returns
Type Description
AllocationPolicy.Builder

clearProvisioningModels() (deprecated)

public AllocationPolicy.Builder clearProvisioningModels()

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

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

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

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

clearServiceAccount()

public AllocationPolicy.Builder clearServiceAccount()

Service account that VMs will run as.

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

Returns
Type Description
AllocationPolicy.Builder

clearServiceAccountEmail() (deprecated)

public AllocationPolicy.Builder clearServiceAccountEmail()

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

Deprecated: please use service_account instead.

string service_account_email = 5 [deprecated = true];

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

clearTags()

public AllocationPolicy.Builder clearTags()

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

clone()

public AllocationPolicy.Builder clone()
Returns
Type Description
AllocationPolicy.Builder
Overrides

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

getDefaultInstanceForType()

public AllocationPolicy getDefaultInstanceForType()
Returns
Type Description
AllocationPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInstance() (deprecated)

public AllocationPolicy.InstancePolicy getInstance()

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

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

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

Returns
Type Description
AllocationPolicy.InstancePolicy

The instance.

getInstanceBuilder() (deprecated)

public AllocationPolicy.InstancePolicy.Builder getInstanceBuilder()

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

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

Returns
Type Description
AllocationPolicy.InstancePolicy.Builder

getInstanceOrBuilder() (deprecated)

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=587

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=587

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=587

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=587

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

getInstancesBuilder(int index)

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

getInstancesBuilderList()

public List<AllocationPolicy.InstancePolicyOrTemplate.Builder> getInstancesBuilderList()

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<Builder>

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() (deprecated)

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.

getLocationBuilder()

public AllocationPolicy.LocationPolicy.Builder getLocationBuilder()

Location where compute resources should be allocated for the Job.

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

Returns
Type Description
AllocationPolicy.LocationPolicy.Builder

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getNetwork()

public AllocationPolicy.NetworkPolicy getNetwork()

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Returns
Type Description
AllocationPolicy.NetworkPolicy

The network.

getNetworkBuilder()

public AllocationPolicy.NetworkPolicy.Builder getNetworkBuilder()

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Returns
Type Description
AllocationPolicy.NetworkPolicy.Builder

getNetworkOrBuilder()

public AllocationPolicy.NetworkPolicyOrBuilder getNetworkOrBuilder()

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Returns
Type Description
AllocationPolicy.NetworkPolicyOrBuilder

getPlacement()

public AllocationPolicy.PlacementPolicy getPlacement()

The placement policy.

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

Returns
Type Description
AllocationPolicy.PlacementPolicy

The placement.

getPlacementBuilder()

public AllocationPolicy.PlacementPolicy.Builder getPlacementBuilder()

The placement policy.

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

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

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=590

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=590

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=590

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=590

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=590

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.

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.

getServiceAccountBuilder()

public ServiceAccount.Builder getServiceAccountBuilder()

Service account that VMs will run as.

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

Returns
Type Description
ServiceAccount.Builder

getServiceAccountEmail() (deprecated)

public String getServiceAccountEmail()

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

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=593

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

getTags(int index)

public String getTags(int index)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the tags.

hasInstance() (deprecated)

public boolean hasInstance()

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

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.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

.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.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AllocationPolicy other)

public AllocationPolicy.Builder mergeFrom(AllocationPolicy other)
Parameter
Name Description
other AllocationPolicy
Returns
Type Description
AllocationPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AllocationPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllocationPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AllocationPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AllocationPolicy.Builder
Overrides

mergeInstance(AllocationPolicy.InstancePolicy value) (deprecated)

public AllocationPolicy.Builder mergeInstance(AllocationPolicy.InstancePolicy value)

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

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

Parameter
Name Description
value AllocationPolicy.InstancePolicy
Returns
Type Description
AllocationPolicy.Builder

mergeLocation(AllocationPolicy.LocationPolicy value)

public AllocationPolicy.Builder mergeLocation(AllocationPolicy.LocationPolicy value)

Location where compute resources should be allocated for the Job.

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

Parameter
Name Description
value AllocationPolicy.LocationPolicy
Returns
Type Description
AllocationPolicy.Builder

mergeNetwork(AllocationPolicy.NetworkPolicy value)

public AllocationPolicy.Builder mergeNetwork(AllocationPolicy.NetworkPolicy value)

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Parameter
Name Description
value AllocationPolicy.NetworkPolicy
Returns
Type Description
AllocationPolicy.Builder

mergePlacement(AllocationPolicy.PlacementPolicy value)

public AllocationPolicy.Builder mergePlacement(AllocationPolicy.PlacementPolicy value)

The placement policy.

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

Parameter
Name Description
value AllocationPolicy.PlacementPolicy
Returns
Type Description
AllocationPolicy.Builder

mergeServiceAccount(ServiceAccount value)

public AllocationPolicy.Builder mergeServiceAccount(ServiceAccount value)

Service account that VMs will run as.

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

Parameter
Name Description
value ServiceAccount
Returns
Type Description
AllocationPolicy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AllocationPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AllocationPolicy.Builder
Overrides

putAllLabels(Map<String,String> values)

public AllocationPolicy.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
AllocationPolicy.Builder

putLabels(String key, String value)

public AllocationPolicy.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
AllocationPolicy.Builder

removeInstances(int index)

public AllocationPolicy.Builder removeInstances(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.Builder

removeLabels(String key)

public AllocationPolicy.Builder removeLabels(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
AllocationPolicy.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AllocationPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AllocationPolicy.Builder
Overrides

setInstance(AllocationPolicy.InstancePolicy value) (deprecated)

public AllocationPolicy.Builder setInstance(AllocationPolicy.InstancePolicy value)

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

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

Parameter
Name Description
value AllocationPolicy.InstancePolicy
Returns
Type Description
AllocationPolicy.Builder

setInstance(AllocationPolicy.InstancePolicy.Builder builderForValue) (deprecated)

public AllocationPolicy.Builder setInstance(AllocationPolicy.InstancePolicy.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue AllocationPolicy.InstancePolicy.Builder
Returns
Type Description
AllocationPolicy.Builder

setInstanceTemplates(int index, String value) (deprecated)

public AllocationPolicy.Builder setInstanceTemplates(int index, String value)

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

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

repeated string instance_templates = 3 [deprecated = true];

Parameters
Name Description
index int

The index to set the value at.

value String

The instanceTemplates to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

setInstances(int index, AllocationPolicy.InstancePolicyOrTemplate value)

public AllocationPolicy.Builder setInstances(int index, AllocationPolicy.InstancePolicyOrTemplate value)

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

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

Parameters
Name Description
index int
value AllocationPolicy.InstancePolicyOrTemplate
Returns
Type Description
AllocationPolicy.Builder

setInstances(int index, AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

public AllocationPolicy.Builder setInstances(int index, AllocationPolicy.InstancePolicyOrTemplate.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue AllocationPolicy.InstancePolicyOrTemplate.Builder
Returns
Type Description
AllocationPolicy.Builder

setLocation(AllocationPolicy.LocationPolicy value)

public AllocationPolicy.Builder setLocation(AllocationPolicy.LocationPolicy value)

Location where compute resources should be allocated for the Job.

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

Parameter
Name Description
value AllocationPolicy.LocationPolicy
Returns
Type Description
AllocationPolicy.Builder

setLocation(AllocationPolicy.LocationPolicy.Builder builderForValue)

public AllocationPolicy.Builder setLocation(AllocationPolicy.LocationPolicy.Builder builderForValue)

Location where compute resources should be allocated for the Job.

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

Parameter
Name Description
builderForValue AllocationPolicy.LocationPolicy.Builder
Returns
Type Description
AllocationPolicy.Builder

setNetwork(AllocationPolicy.NetworkPolicy value)

public AllocationPolicy.Builder setNetwork(AllocationPolicy.NetworkPolicy value)

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Parameter
Name Description
value AllocationPolicy.NetworkPolicy
Returns
Type Description
AllocationPolicy.Builder

setNetwork(AllocationPolicy.NetworkPolicy.Builder builderForValue)

public AllocationPolicy.Builder setNetwork(AllocationPolicy.NetworkPolicy.Builder builderForValue)

The network policy.

If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.

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

Parameter
Name Description
builderForValue AllocationPolicy.NetworkPolicy.Builder
Returns
Type Description
AllocationPolicy.Builder

setPlacement(AllocationPolicy.PlacementPolicy value)

public AllocationPolicy.Builder setPlacement(AllocationPolicy.PlacementPolicy value)

The placement policy.

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

Parameter
Name Description
value AllocationPolicy.PlacementPolicy
Returns
Type Description
AllocationPolicy.Builder

setPlacement(AllocationPolicy.PlacementPolicy.Builder builderForValue)

public AllocationPolicy.Builder setPlacement(AllocationPolicy.PlacementPolicy.Builder builderForValue)

The placement policy.

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

Parameter
Name Description
builderForValue AllocationPolicy.PlacementPolicy.Builder
Returns
Type Description
AllocationPolicy.Builder

setProvisioningModels(int index, AllocationPolicy.ProvisioningModel value) (deprecated)

public AllocationPolicy.Builder setProvisioningModels(int index, AllocationPolicy.ProvisioningModel value)

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

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

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

Parameters
Name Description
index int

The index to set the value at.

value AllocationPolicy.ProvisioningModel

The provisioningModels to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

setProvisioningModelsValue(int index, int value) (deprecated)

public AllocationPolicy.Builder setProvisioningModelsValue(int index, int value)

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

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

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

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for provisioningModels to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

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

public AllocationPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AllocationPolicy.Builder
Overrides

setServiceAccount(ServiceAccount value)

public AllocationPolicy.Builder setServiceAccount(ServiceAccount value)

Service account that VMs will run as.

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

Parameter
Name Description
value ServiceAccount
Returns
Type Description
AllocationPolicy.Builder

setServiceAccount(ServiceAccount.Builder builderForValue)

public AllocationPolicy.Builder setServiceAccount(ServiceAccount.Builder builderForValue)

Service account that VMs will run as.

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

Parameter
Name Description
builderForValue ServiceAccount.Builder
Returns
Type Description
AllocationPolicy.Builder

setServiceAccountEmail(String value) (deprecated)

public AllocationPolicy.Builder setServiceAccountEmail(String value)

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

Deprecated: please use service_account instead.

string service_account_email = 5 [deprecated = true];

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value) (deprecated)

public AllocationPolicy.Builder setServiceAccountEmailBytes(ByteString value)

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

Deprecated: please use service_account instead.

string service_account_email = 5 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

setTags(int index, String value)

public AllocationPolicy.Builder setTags(int index, String value)

Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The tags to set.

Returns
Type Description
AllocationPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AllocationPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AllocationPolicy.Builder
Overrides