Class AllocationPolicy.LocationPolicy.Builder (0.95.0)

0.95.0 (latest) 0.94.0 0.93.0 0.91.0 0.88.0 0.87.0 0.85.0 0.83.0 0.82.0 0.81.0 0.80.0 0.78.0 0.76.0 0.75.0 0.74.0 0.73.0 0.72.0 0.70.0 0.68.0 0.67.0 0.64.0 0.63.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.2 0.2.2 0.1.1

public static final class AllocationPolicy.LocationPolicy.Builder extends GeneratedMessage.Builder<AllocationPolicy.LocationPolicy.Builder> implements AllocationPolicy.LocationPolicyOrBuilder

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AllocationPolicy.LocationPolicy.Builder

Implements

AllocationPolicy.LocationPolicyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAllowedLocations(Iterable<String> values)

public AllocationPolicy.LocationPolicy.Builder addAllAllowedLocations(Iterable<String> values)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameter
Name	Description
values	Iterable<String> The allowedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

addAllDeniedLocations(Iterable<String> values)

public AllocationPolicy.LocationPolicy.Builder addAllDeniedLocations(Iterable<String> values)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameter
Name	Description
values	Iterable<String> The deniedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

addAllowedLocations(String value)

public AllocationPolicy.LocationPolicy.Builder addAllowedLocations(String value)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameter
Name	Description
value	String The allowedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

addAllowedLocationsBytes(ByteString value)

public AllocationPolicy.LocationPolicy.Builder addAllowedLocationsBytes(ByteString value)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameter
Name	Description
value	ByteString The bytes of the allowedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

addDeniedLocations(String value)

public AllocationPolicy.LocationPolicy.Builder addDeniedLocations(String value)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameter
Name	Description
value	String The deniedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

addDeniedLocationsBytes(ByteString value)

public AllocationPolicy.LocationPolicy.Builder addDeniedLocationsBytes(ByteString value)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameter
Name	Description
value	ByteString The bytes of the deniedLocations to add.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

build()

public AllocationPolicy.LocationPolicy build()

Returns
Type	Description
AllocationPolicy.LocationPolicy

buildPartial()

public AllocationPolicy.LocationPolicy buildPartial()

Returns
Type	Description
AllocationPolicy.LocationPolicy

clear()

public AllocationPolicy.LocationPolicy.Builder clear()

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAllowedLocations()

public AllocationPolicy.LocationPolicy.Builder clearAllowedLocations()

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

clearDeniedLocations()

public AllocationPolicy.LocationPolicy.Builder clearDeniedLocations()

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

getAllowedLocations(int index)

public String getAllowedLocations(int index)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedLocations at the given index.

getAllowedLocationsBytes(int index)

public ByteString getAllowedLocationsBytes(int index)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedLocations at the given index.

getAllowedLocationsCount()

public int getAllowedLocationsCount()

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Returns
Type	Description
int	The count of allowedLocations.

getAllowedLocationsList()

public ProtocolStringList getAllowedLocationsList()

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Returns
Type	Description
ProtocolStringList	A list containing the allowedLocations.

getDefaultInstanceForType()

public AllocationPolicy.LocationPolicy getDefaultInstanceForType()

Returns
Type	Description
AllocationPolicy.LocationPolicy

getDeniedLocations(int index)

public String getDeniedLocations(int index)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The deniedLocations at the given index.

getDeniedLocationsBytes(int index)

public ByteString getDeniedLocationsBytes(int index)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the deniedLocations at the given index.

getDeniedLocationsCount()

public int getDeniedLocationsCount()

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Returns
Type	Description
int	The count of deniedLocations.

getDeniedLocationsList()

public ProtocolStringList getDeniedLocationsList()

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Returns
Type	Description
ProtocolStringList	A list containing the deniedLocations.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(AllocationPolicy.LocationPolicy other)

public AllocationPolicy.LocationPolicy.Builder mergeFrom(AllocationPolicy.LocationPolicy other)

Parameter
Name	Description
other	AllocationPolicy.LocationPolicy

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AllocationPolicy.LocationPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AllocationPolicy.LocationPolicy.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setAllowedLocations(int index, String value)

public AllocationPolicy.LocationPolicy.Builder setAllowedLocations(int index, String value)

A list of location names that are allowed for the job's VMs formatted as URLs. Each location can be a region or a zone, but you can only specify one region or multiple zones in one region per job. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1, and ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. However, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] causes an error because it contains multiple regions (us-central1 and us-west1).

The specified region or zones must be in the same region in which the job is created starting on the following dates:

• For projects that have successfully submitted before July 31, 2026 at least one job that uses the allowedLocations[] field with any region or zones outside of the job's location, the changes are starting on June 30, 2027.

• For all other projects, the changes are starting on July 31, 2026.

  For example, for job projects/123/locations/us-central1/jobs/jobid, the specified region or zones must be in us-central1. Using a different region (e.g. regions/us-west1) or a zone not in us-central1 (e.g. zones/us-west1-a) causes an error.

repeated string allowed_locations = 1;

Parameters
Name	Description
index	int The index to set the value at.
value	String The allowedLocations to set.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.

setDeniedLocations(int index, String value)

public AllocationPolicy.LocationPolicy.Builder setDeniedLocations(int index, String value)

A list of denied location names.

Not yet implemented.

repeated string denied_locations = 2;

Parameters
Name	Description
index	int The index to set the value at.
value	String The deniedLocations to set.

Returns
Type	Description
AllocationPolicy.LocationPolicy.Builder	This builder for chaining.