io.envoyproxy.envoy.config.cluster.v3

Class LoadBalancingPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadBalancingPolicyOrBuilder, Serializable

public final class LoadBalancingPolicy
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadBalancingPolicy.Builder [#not-implemented-hide:] Extensible load balancing policy configuration.
static class	LoadBalancingPolicy.Policy Protobuf type envoy.config.cluster.v3.LoadBalancingPolicy.Policy
static interface	LoadBalancingPolicy.PolicyOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	POLICIES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static LoadBalancingPolicy	getDefaultInstance()
LoadBalancingPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<LoadBalancingPolicy>	getParserForType()
LoadBalancingPolicy.Policy	getPolicies(int index) 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.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LoadBalancingPolicy.Builder	newBuilder()
static LoadBalancingPolicy.Builder	newBuilder(LoadBalancingPolicy prototype)
LoadBalancingPolicy.Builder	newBuilderForType()
protected LoadBalancingPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LoadBalancingPolicy	parseDelimitedFrom(InputStream input)
static LoadBalancingPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadBalancingPolicy	parseFrom(byte[] data)
static LoadBalancingPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadBalancingPolicy	parseFrom(ByteBuffer data)
static LoadBalancingPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadBalancingPolicy	parseFrom(com.google.protobuf.ByteString data)
static LoadBalancingPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadBalancingPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static LoadBalancingPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadBalancingPolicy	parseFrom(InputStream input)
static LoadBalancingPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LoadBalancingPolicy>	parser()
LoadBalancingPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

POLICIES_FIELD_NUMBER

public static final int POLICIES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LoadBalancingPolicy parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadBalancingPolicy parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static LoadBalancingPolicy parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static LoadBalancingPolicy parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static LoadBalancingPolicy parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static LoadBalancingPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static LoadBalancingPolicy parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public LoadBalancingPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LoadBalancingPolicy.Builder newBuilder()

newBuilder

public static LoadBalancingPolicy.Builder newBuilder(LoadBalancingPolicy prototype)

toBuilder

public LoadBalancingPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LoadBalancingPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LoadBalancingPolicy getDefaultInstance()

parser

public static com.google.protobuf.Parser<LoadBalancingPolicy> parser()

getParserForType

public com.google.protobuf.Parser<LoadBalancingPolicy> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LoadBalancingPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder