Package io.envoyproxy.envoy.config.cluster.v3

Class LoadBalancingPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage implements LoadBalancingPolicyOrBuilder
 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:

  • Field Details

  • Constructor Details

    • LoadBalancingPolicy

      private LoadBalancingPolicy(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • LoadBalancingPolicy

      private LoadBalancingPolicy()

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public LoadBalancingPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder