java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.api.v2.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.api.v2.LoadBalancingPolicy

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`LoadBalancingPolicy.Builder`	[#not-implemented-hide:] Extensible load balancing policy configuration.
`static class`	`LoadBalancingPolicy.Policy`	Protobuf type `envoy.api.v2.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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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(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 LoadBalancingPolicy`	`parseFrom(ByteBuffer data)`
`static LoadBalancingPolicy`	`parseFrom(ByteBuffer data, 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, isStringEmpty, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

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