Package io.envoyproxy.envoy.extensions.load_balancing_policies.least_request.v3

Class LeastRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LeastRequestOrBuilder, Serializable
    public final class LeastRequest
extends com.google.protobuf.GeneratedMessageV3
implements LeastRequestOrBuilder
     This configuration allows the built-in LEAST_REQUEST LB policy to be configured via the LB policy
 extension point. See the :ref:`load balancing architecture overview
 <arch_overview_load_balancing_types>` for more information.
 [#extension: envoy.clusters.lb_policy]
    Protobuf type envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LeastRequest.Builder
      This configuration allows the built-in LEAST_REQUEST LB policy to be configured via the LB policy extension point.

      • 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 ACTIVE_REQUEST_BIAS_FIELD_NUMBER  
      static int CHOICE_COUNT_FIELD_NUMBER  
      static int SLOW_START_CONFIG_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)  
      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 LeastRequest getDefaultInstance()  
      LeastRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<LeastRequest> getParserForType()  
      int getSerializedSize()  
      Cluster.SlowStartConfig getSlowStartConfig()
      Configuration for slow start mode.
      Cluster.SlowStartConfigOrBuilder getSlowStartConfigOrBuilder()
      Configuration for slow start mode.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static LeastRequest.Builder newBuilder()  
      static LeastRequest.Builder newBuilder​(LeastRequest prototype)  
      LeastRequest.Builder newBuilderForType()  
      protected LeastRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static LeastRequest parseDelimitedFrom​(InputStream input)  
      static LeastRequest parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LeastRequest parseFrom​(byte[] data)  
      static LeastRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LeastRequest parseFrom​(com.google.protobuf.ByteString data)  
      static LeastRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LeastRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static LeastRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LeastRequest parseFrom​(InputStream input)  
      static LeastRequest parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LeastRequest parseFrom​(ByteBuffer data)  
      static LeastRequest parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<LeastRequest> parser()  
      LeastRequest.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 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

      • CHOICE_COUNT_FIELD_NUMBER

        public static final int CHOICE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVE_REQUEST_BIAS_FIELD_NUMBER

        public static final int ACTIVE_REQUEST_BIAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SLOW_START_CONFIG_FIELD_NUMBER

        public static final int SLOW_START_CONFIG_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

      • 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 LeastRequestOrBuilder
        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 LeastRequestOrBuilder
        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 LeastRequestOrBuilder

      • 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 LeastRequestOrBuilder
        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 LeastRequestOrBuilder
        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 LeastRequestOrBuilder

      • 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 LeastRequestOrBuilder
        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 LeastRequestOrBuilder
        Returns:
        The slowStartConfig.

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

      • parseFrom

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

      • parseFrom

        public static LeastRequest parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected LeastRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static LeastRequest getDefaultInstance()

      • parser

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

      • getParserForType

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