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

Class Cluster.LeastRequestLbConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.Cluster.LeastRequestLbConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.LeastRequestLbConfigOrBuilder, Serializable
Enclosing class:
Cluster
public static final class Cluster.LeastRequestLbConfig extends com.google.protobuf.GeneratedMessage implements Cluster.LeastRequestLbConfigOrBuilder
 Specific configuration for the LeastRequest load balancing policy.
Protobuf type envoy.config.cluster.v3.Cluster.LeastRequestLbConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Cluster.LeastRequestLbConfig.Builder
    Specific configuration for the LeastRequest load balancing policy.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTIVE_REQUEST_BIAS_FIELD_NUMBER
     
    static final int
    CHOICE_COUNT_FIELD_NUMBER
     
    static final int
    SLOW_START_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    RuntimeDouble
    getActiveRequestBias()
    The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
    RuntimeDoubleOrBuilder
    getActiveRequestBiasOrBuilder()
    The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
    com.google.protobuf.UInt32Value
    getChoiceCount()
    The number of random healthy hosts from which the host with the fewest active requests will be chosen.
    com.google.protobuf.UInt32ValueOrBuilder
    getChoiceCountOrBuilder()
    The number of random healthy hosts from which the host with the fewest active requests will be chosen.
    static Cluster.LeastRequestLbConfig
    getDefaultInstance()
     
    Cluster.LeastRequestLbConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Parser<Cluster.LeastRequestLbConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    Cluster.SlowStartConfig
    getSlowStartConfig()
    Configuration for slow start mode.
    Cluster.SlowStartConfigOrBuilder
    getSlowStartConfigOrBuilder()
    Configuration for slow start mode.
    boolean
    hasActiveRequestBias()
    The following formula is used to calculate the dynamic weights when hosts have different load balancing weights: ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias`` The larger the active request bias is, the more aggressively active requests will lower the effective weight when all host weights are not equal.
    boolean
    hasChoiceCount()
    The number of random healthy hosts from which the host with the fewest active requests will be chosen.
    int
    hashCode()
     
    boolean
    hasSlowStartConfig()
    Configuration for slow start mode.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Cluster.LeastRequestLbConfig.Builder
    newBuilder()
     
    static Cluster.LeastRequestLbConfig.Builder
    newBuilder(Cluster.LeastRequestLbConfig prototype)
     
    Cluster.LeastRequestLbConfig.Builder
    newBuilderForType()
     
    protected Cluster.LeastRequestLbConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Cluster.LeastRequestLbConfig
    parseDelimitedFrom(InputStream input)
     
    static Cluster.LeastRequestLbConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(byte[] data)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(InputStream input)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(ByteBuffer data)
     
    static Cluster.LeastRequestLbConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Cluster.LeastRequestLbConfig>
    parser()
     
    Cluster.LeastRequestLbConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • CHOICE_COUNT_FIELD_NUMBER

      public static final int CHOICE_COUNT_FIELD_NUMBER
      See Also:

    • ACTIVE_REQUEST_BIAS_FIELD_NUMBER

      public static final int ACTIVE_REQUEST_BIAS_FIELD_NUMBER
      See Also:

    • SLOW_START_CONFIG_FIELD_NUMBER

      public static final int SLOW_START_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • hasChoiceCount

      public boolean hasChoiceCount()
       The number of random healthy hosts from which the host with the fewest active requests will
 be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
      .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
      Specified by:
      hasChoiceCount in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      Whether the choiceCount field is set.

    • getChoiceCount

      public com.google.protobuf.UInt32Value getChoiceCount()
       The number of random healthy hosts from which the host with the fewest active requests will
 be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
      .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
      Specified by:
      getChoiceCount in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      The choiceCount.

    • getChoiceCountOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getChoiceCountOrBuilder()
       The number of random healthy hosts from which the host with the fewest active requests will
 be chosen. Defaults to 2 so that we perform two-choice selection if the field is not set.
      .google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }
      Specified by:
      getChoiceCountOrBuilder in interface Cluster.LeastRequestLbConfigOrBuilder

    • hasActiveRequestBias

      public boolean hasActiveRequestBias()
       The following formula is used to calculate the dynamic weights when hosts have different load
 balancing weights:

 ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``

 The larger the active request bias is, the more aggressively active requests will lower the
 effective weight when all host weights are not equal.

 ``active_request_bias`` must be greater than or equal to 0.0.

 When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
 of active requests at the time it picks a host and behaves like the Round Robin Load
 Balancer.

 When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
 weight by the number of active requests at the time it does a pick.

 The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
 host sets changes, e.g., whenever there is a host membership update or a host load balancing
 weight change.

 .. note::
 This setting only takes effect if all host weights are not equal.
      .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
      Specified by:
      hasActiveRequestBias in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      Whether the activeRequestBias field is set.

    • getActiveRequestBias

      public RuntimeDouble getActiveRequestBias()
       The following formula is used to calculate the dynamic weights when hosts have different load
 balancing weights:

 ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``

 The larger the active request bias is, the more aggressively active requests will lower the
 effective weight when all host weights are not equal.

 ``active_request_bias`` must be greater than or equal to 0.0.

 When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
 of active requests at the time it picks a host and behaves like the Round Robin Load
 Balancer.

 When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
 weight by the number of active requests at the time it does a pick.

 The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
 host sets changes, e.g., whenever there is a host membership update or a host load balancing
 weight change.

 .. note::
 This setting only takes effect if all host weights are not equal.
      .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
      Specified by:
      getActiveRequestBias in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      The activeRequestBias.

    • getActiveRequestBiasOrBuilder

      public RuntimeDoubleOrBuilder getActiveRequestBiasOrBuilder()
       The following formula is used to calculate the dynamic weights when hosts have different load
 balancing weights:

 ``weight = load_balancing_weight / (active_requests + 1)^active_request_bias``

 The larger the active request bias is, the more aggressively active requests will lower the
 effective weight when all host weights are not equal.

 ``active_request_bias`` must be greater than or equal to 0.0.

 When ``active_request_bias == 0.0`` the Least Request Load Balancer doesn't consider the number
 of active requests at the time it picks a host and behaves like the Round Robin Load
 Balancer.

 When ``active_request_bias > 0.0`` the Least Request Load Balancer scales the load balancing
 weight by the number of active requests at the time it does a pick.

 The value is cached for performance reasons and refreshed whenever one of the Load Balancer's
 host sets changes, e.g., whenever there is a host membership update or a host load balancing
 weight change.

 .. note::
 This setting only takes effect if all host weights are not equal.
      .envoy.config.core.v3.RuntimeDouble active_request_bias = 2;
      Specified by:
      getActiveRequestBiasOrBuilder in interface Cluster.LeastRequestLbConfigOrBuilder

    • hasSlowStartConfig

      public boolean hasSlowStartConfig()
       Configuration for slow start mode.
 If this configuration is not set, slow start will not be not enabled.
      .envoy.config.cluster.v3.Cluster.SlowStartConfig slow_start_config = 3;
      Specified by:
      hasSlowStartConfig in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      Whether the slowStartConfig field is set.

    • getSlowStartConfig

      public Cluster.SlowStartConfig getSlowStartConfig()
       Configuration for slow start mode.
 If this configuration is not set, slow start will not be not enabled.
      .envoy.config.cluster.v3.Cluster.SlowStartConfig slow_start_config = 3;
      Specified by:
      getSlowStartConfig in interface Cluster.LeastRequestLbConfigOrBuilder
      Returns:
      The slowStartConfig.

    • getSlowStartConfigOrBuilder

      public Cluster.SlowStartConfigOrBuilder getSlowStartConfigOrBuilder()
       Configuration for slow start mode.
 If this configuration is not set, slow start will not be not enabled.
      .envoy.config.cluster.v3.Cluster.SlowStartConfig slow_start_config = 3;
      Specified by:
      getSlowStartConfigOrBuilder in interface Cluster.LeastRequestLbConfigOrBuilder

    • 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 Cluster.LeastRequestLbConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Cluster.LeastRequestLbConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Cluster.LeastRequestLbConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Cluster.LeastRequestLbConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Cluster.LeastRequestLbConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Cluster.LeastRequestLbConfig.Builder newBuilder()

    • newBuilder

      public static Cluster.LeastRequestLbConfig.Builder newBuilder(Cluster.LeastRequestLbConfig prototype)

    • toBuilder

      public Cluster.LeastRequestLbConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Cluster.LeastRequestLbConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Cluster.LeastRequestLbConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Cluster.LeastRequestLbConfig> 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 Cluster.LeastRequestLbConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder