io.envoyproxy.envoy.config.cluster.v3

Class LoadBalancingPolicy.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

io.envoyproxy.envoy.config.cluster.v3.LoadBalancingPolicy.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadBalancingPolicyOrBuilder, Cloneable

Enclosing class:

LoadBalancingPolicy

public static final class LoadBalancingPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>
implements LoadBalancingPolicyOrBuilder

 [#not-implemented-hide:] Extensible load balancing policy configuration.
 Every LB policy defined via this mechanism will be identified via a unique name using reverse
 DNS notation. If the policy needs configuration parameters, it must define a message for its
 own configuration, which will be stored in the config field. The name of the policy will tell
 clients which type of message they should expect to see in the config field.
 Note that there are cases where it is useful to be able to independently select LB policies
 for choosing a locality and for choosing an endpoint within that locality. For example, a
 given deployment may always use the same policy to choose the locality, but for choosing the
 endpoint within the locality, some clusters may use weighted-round-robin, while others may
 use some sort of session-based balancing.
 This can be accomplished via hierarchical LB policies, where the parent LB policy creates a
 child LB policy for each locality. For each request, the parent chooses the locality and then
 delegates to the child policy for that locality to choose the endpoint within the locality.
 To facilitate this, the config message for the top-level LB policy may include a field of
 type LoadBalancingPolicy that specifies the child policy.
 

Protobuf type envoy.config.cluster.v3.LoadBalancingPolicy

Method Summary

Modifier and Type	Method and Description
LoadBalancingPolicy.Builder	addAllPolicies(Iterable<? extends LoadBalancingPolicy.Policy> values) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	addPolicies(int index, LoadBalancingPolicy.Policy.Builder builderForValue) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	addPolicies(int index, LoadBalancingPolicy.Policy value) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	addPolicies(LoadBalancingPolicy.Policy.Builder builderForValue) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	addPolicies(LoadBalancingPolicy.Policy value) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Policy.Builder	addPoliciesBuilder() Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Policy.Builder	addPoliciesBuilder(int index) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LoadBalancingPolicy	build()
LoadBalancingPolicy	buildPartial()
LoadBalancingPolicy.Builder	clear()
LoadBalancingPolicy.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
LoadBalancingPolicy.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
LoadBalancingPolicy.Builder	clearPolicies() Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	clone()
LoadBalancingPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
LoadBalancingPolicy.Policy	getPolicies(int index) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Policy.Builder	getPoliciesBuilder(int index) Each client will iterate over the list in order and stop at the first policy that it supports.
List<LoadBalancingPolicy.Policy.Builder>	getPoliciesBuilderList() Each client will iterate over the list in order and stop at the first policy that it supports.
int	getPoliciesCount() Each client will iterate over the list in order and stop at the first policy that it supports.
List<LoadBalancingPolicy.Policy>	getPoliciesList() Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.PolicyOrBuilder	getPoliciesOrBuilder(int index) Each client will iterate over the list in order and stop at the first policy that it supports.
List<? extends LoadBalancingPolicy.PolicyOrBuilder>	getPoliciesOrBuilderList() Each client will iterate over the list in order and stop at the first policy that it supports.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LoadBalancingPolicy.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LoadBalancingPolicy.Builder	mergeFrom(LoadBalancingPolicy other)
LoadBalancingPolicy.Builder	mergeFrom(com.google.protobuf.Message other)
LoadBalancingPolicy.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LoadBalancingPolicy.Builder	removePolicies(int index) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LoadBalancingPolicy.Builder	setPolicies(int index, LoadBalancingPolicy.Policy.Builder builderForValue) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	setPolicies(int index, LoadBalancingPolicy.Policy value) Each client will iterate over the list in order and stop at the first policy that it supports.
LoadBalancingPolicy.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
LoadBalancingPolicy.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

clear

public LoadBalancingPolicy.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

getDefaultInstanceForType

public LoadBalancingPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LoadBalancingPolicy build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public LoadBalancingPolicy buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public LoadBalancingPolicy.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

setField

public LoadBalancingPolicy.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

clearField

public LoadBalancingPolicy.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

clearOneof

public LoadBalancingPolicy.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

setRepeatedField

public LoadBalancingPolicy.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

addRepeatedField

public LoadBalancingPolicy.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

mergeFrom

public LoadBalancingPolicy.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LoadBalancingPolicy.Builder>

mergeFrom

public LoadBalancingPolicy.Builder mergeFrom(LoadBalancingPolicy other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

mergeFrom

public LoadBalancingPolicy.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LoadBalancingPolicy.Builder>

Throws:

IOException

getPoliciesList

public List<LoadBalancingPolicy.Policy> getPoliciesList()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

Specified by:

getPoliciesList in interface LoadBalancingPolicyOrBuilder

getPoliciesCount

public int getPoliciesCount()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

Specified by:

getPoliciesCount in interface LoadBalancingPolicyOrBuilder

getPolicies

public LoadBalancingPolicy.Policy getPolicies(int index)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

Specified by:

getPolicies in interface LoadBalancingPolicyOrBuilder

setPolicies

public LoadBalancingPolicy.Builder setPolicies(int index,
                                               LoadBalancingPolicy.Policy value)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

setPolicies

public LoadBalancingPolicy.Builder setPolicies(int index,
                                               LoadBalancingPolicy.Policy.Builder builderForValue)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addPolicies

public LoadBalancingPolicy.Builder addPolicies(LoadBalancingPolicy.Policy value)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addPolicies

public LoadBalancingPolicy.Builder addPolicies(int index,
                                               LoadBalancingPolicy.Policy value)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addPolicies

public LoadBalancingPolicy.Builder addPolicies(LoadBalancingPolicy.Policy.Builder builderForValue)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addPolicies

public LoadBalancingPolicy.Builder addPolicies(int index,
                                               LoadBalancingPolicy.Policy.Builder builderForValue)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addAllPolicies

public LoadBalancingPolicy.Builder addAllPolicies(Iterable<? extends LoadBalancingPolicy.Policy> values)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

clearPolicies

public LoadBalancingPolicy.Builder clearPolicies()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

removePolicies

public LoadBalancingPolicy.Builder removePolicies(int index)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

getPoliciesBuilder

public LoadBalancingPolicy.Policy.Builder getPoliciesBuilder(int index)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

getPoliciesOrBuilder

public LoadBalancingPolicy.PolicyOrBuilder getPoliciesOrBuilder(int index)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

Specified by:

getPoliciesOrBuilder in interface LoadBalancingPolicyOrBuilder

getPoliciesOrBuilderList

public List<? extends LoadBalancingPolicy.PolicyOrBuilder> getPoliciesOrBuilderList()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

Specified by:

getPoliciesOrBuilderList in interface LoadBalancingPolicyOrBuilder

addPoliciesBuilder

public LoadBalancingPolicy.Policy.Builder addPoliciesBuilder()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

addPoliciesBuilder

public LoadBalancingPolicy.Policy.Builder addPoliciesBuilder(int index)

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

getPoliciesBuilderList

public List<LoadBalancingPolicy.Policy.Builder> getPoliciesBuilderList()

 Each client will iterate over the list in order and stop at the first policy that it
 supports. This provides a mechanism for starting to use new LB policies that are not yet
 supported by all clients.
 

repeated .envoy.config.cluster.v3.LoadBalancingPolicy.Policy policies = 1;

setUnknownFields

public final LoadBalancingPolicy.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>

mergeUnknownFields

public final LoadBalancingPolicy.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LoadBalancingPolicy.Builder>