Class AllocationPolicy.PlacementPolicy.Builder (0.47.0)

public static final class AllocationPolicy.PlacementPolicy.Builder extends GeneratedMessageV3.Builder<AllocationPolicy.PlacementPolicy.Builder> implements AllocationPolicy.PlacementPolicyOrBuilder

PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.

Protobuf type google.cloud.batch.v1.AllocationPolicy.PlacementPolicy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AllocationPolicy.PlacementPolicy build()
Returns
Type Description
AllocationPolicy.PlacementPolicy

buildPartial()

public AllocationPolicy.PlacementPolicy buildPartial()
Returns
Type Description
AllocationPolicy.PlacementPolicy

clear()

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

clearCollocation()

public AllocationPolicy.PlacementPolicy.Builder clearCollocation()

UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.

string collocation = 1;

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMaxDistance()

public AllocationPolicy.PlacementPolicy.Builder clearMaxDistance()

When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

int64 max_distance = 2;

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getCollocation()

public String getCollocation()

UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.

string collocation = 1;

Returns
Type Description
String

The collocation.

getCollocationBytes()

public ByteString getCollocationBytes()

UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.

string collocation = 1;

Returns
Type Description
ByteString

The bytes for collocation.

getDefaultInstanceForType()

public AllocationPolicy.PlacementPolicy getDefaultInstanceForType()
Returns
Type Description
AllocationPolicy.PlacementPolicy

getDescriptorForType()

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

getMaxDistance()

public long getMaxDistance()

When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

int64 max_distance = 2;

Returns
Type Description
long

The maxDistance.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AllocationPolicy.PlacementPolicy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCollocation(String value)

public AllocationPolicy.PlacementPolicy.Builder setCollocation(String value)

UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.

string collocation = 1;

Parameter
Name Description
value String

The collocation to set.

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

This builder for chaining.

setCollocationBytes(ByteString value)

public AllocationPolicy.PlacementPolicy.Builder setCollocationBytes(ByteString value)

UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.

string collocation = 1;

Parameter
Name Description
value ByteString

The bytes for collocation to set.

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMaxDistance(long value)

public AllocationPolicy.PlacementPolicy.Builder setMaxDistance(long value)

When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

int64 max_distance = 2;

Parameter
Name Description
value long

The maxDistance to set.

Returns
Type Description
AllocationPolicy.PlacementPolicy.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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