Class LeastRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,LeastRequestOrBuilder,Serializable
@Generated
public final class LeastRequest
extends com.google.protobuf.GeneratedMessage
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. [#next-free-field: 7]Protobuf type
envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThis configuration allows the built-in LEAST_REQUEST LB policy to be configured via the LB policy extension point.static enumAvailable methods for selecting the host set from which to return the host with the fewest active requests.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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intprivate RuntimeDoubleprivate intstatic final intprivate com.google.protobuf.UInt32Valueprivate static final LeastRequeststatic final intprivate com.google.protobuf.BoolValuestatic final intprivate LocalityLbConfigprivate byteprivate static final com.google.protobuf.Parser<LeastRequest> static final intprivate intprivate static final longstatic final intprivate SlowStartConfigFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateprivateLeastRequest(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe 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.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.UInt32ValueThe number of random healthy hosts from which the host with the fewest active requests will be chosen.com.google.protobuf.UInt32ValueOrBuilderThe number of random healthy hosts from which the host with the fewest active requests will be chosen.static LeastRequeststatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.BoolValueDeprecated.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated.com.google.protobuf.BoolValueOrBuilderDeprecated.Configuration for local zone aware load balancing or locality weighted load balancing.Configuration for local zone aware load balancing or locality weighted load balancing.com.google.protobuf.Parser<LeastRequest> Method for selecting the host set from which to return the host with the fewest active requests.intMethod for selecting the host set from which to return the host with the fewest active requests.intConfiguration for slow start mode.Configuration for slow start mode.booleanThe 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.booleanThe number of random healthy hosts from which the host with the fewest active requests will be chosen.booleanDeprecated.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated.inthashCode()booleanConfiguration for local zone aware load balancing or locality weighted load balancing.booleanConfiguration for slow start mode.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic LeastRequest.Builderstatic LeastRequest.BuildernewBuilder(LeastRequest prototype) protected LeastRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static LeastRequestparseDelimitedFrom(InputStream input) static LeastRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LeastRequestparseFrom(byte[] data) static LeastRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LeastRequestparseFrom(com.google.protobuf.ByteString data) static LeastRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LeastRequestparseFrom(com.google.protobuf.CodedInputStream input) static LeastRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LeastRequestparseFrom(InputStream input) static LeastRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LeastRequestparseFrom(ByteBuffer data) static LeastRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<LeastRequest> parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
CHOICE_COUNT_FIELD_NUMBER
public static final int CHOICE_COUNT_FIELD_NUMBER- See Also:
-
choiceCount_
private com.google.protobuf.UInt32Value choiceCount_ -
ACTIVE_REQUEST_BIAS_FIELD_NUMBER
public static final int ACTIVE_REQUEST_BIAS_FIELD_NUMBER- See Also:
-
activeRequestBias_
-
SLOW_START_CONFIG_FIELD_NUMBER
public static final int SLOW_START_CONFIG_FIELD_NUMBER- See Also:
-
slowStartConfig_
-
LOCALITY_LB_CONFIG_FIELD_NUMBER
public static final int LOCALITY_LB_CONFIG_FIELD_NUMBER- See Also:
-
localityLbConfig_
-
ENABLE_FULL_SCAN_FIELD_NUMBER
public static final int ENABLE_FULL_SCAN_FIELD_NUMBER- See Also:
-
enableFullScan_
private com.google.protobuf.BoolValue enableFullScan_ -
SELECTION_METHOD_FIELD_NUMBER
public static final int SELECTION_METHOD_FIELD_NUMBER- See Also:
-
selectionMethod_
private int selectionMethod_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
LeastRequest
private LeastRequest(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
LeastRequest
private LeastRequest()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.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. Only applies to the ``N_CHOICES`` selection method.
.google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }- Specified by:
hasChoiceCountin interfaceLeastRequestOrBuilder- 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. Only applies to the ``N_CHOICES`` selection method.
.google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }- Specified by:
getChoiceCountin interfaceLeastRequestOrBuilder- 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. Only applies to the ``N_CHOICES`` selection method.
.google.protobuf.UInt32Value choice_count = 1 [(.validate.rules) = { ... }- Specified by:
getChoiceCountOrBuilderin interfaceLeastRequestOrBuilder
-
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:
hasActiveRequestBiasin interfaceLeastRequestOrBuilder- Returns:
- Whether the activeRequestBias field is set.
-
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:
getActiveRequestBiasin interfaceLeastRequestOrBuilder- Returns:
- The activeRequestBias.
-
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:
getActiveRequestBiasOrBuilderin interfaceLeastRequestOrBuilder
-
hasSlowStartConfig
public boolean hasSlowStartConfig()Configuration for slow start mode. If this configuration is not set, slow start will not be not enabled.
.envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;- Specified by:
hasSlowStartConfigin interfaceLeastRequestOrBuilder- Returns:
- Whether the slowStartConfig field is set.
-
getSlowStartConfig
Configuration for slow start mode. If this configuration is not set, slow start will not be not enabled.
.envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;- Specified by:
getSlowStartConfigin interfaceLeastRequestOrBuilder- Returns:
- The slowStartConfig.
-
getSlowStartConfigOrBuilder
Configuration for slow start mode. If this configuration is not set, slow start will not be not enabled.
.envoy.extensions.load_balancing_policies.common.v3.SlowStartConfig slow_start_config = 3;- Specified by:
getSlowStartConfigOrBuilderin interfaceLeastRequestOrBuilder
-
hasLocalityLbConfig
public boolean hasLocalityLbConfig()Configuration for local zone aware load balancing or locality weighted load balancing.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;- Specified by:
hasLocalityLbConfigin interfaceLeastRequestOrBuilder- Returns:
- Whether the localityLbConfig field is set.
-
getLocalityLbConfig
Configuration for local zone aware load balancing or locality weighted load balancing.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;- Specified by:
getLocalityLbConfigin interfaceLeastRequestOrBuilder- Returns:
- The localityLbConfig.
-
getLocalityLbConfigOrBuilder
Configuration for local zone aware load balancing or locality weighted load balancing.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig locality_lb_config = 4;- Specified by:
getLocalityLbConfigOrBuilderin interfaceLeastRequestOrBuilder
-
hasEnableFullScan
Deprecated.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated. See envoy/extensions/load_balancing_policies/least_request/v3/least_request.proto;l=89[#not-implemented-hide:] Unused. Replaced by the `selection_method` enum for better extensibility.
.google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
hasEnableFullScanin interfaceLeastRequestOrBuilder- Returns:
- Whether the enableFullScan field is set.
-
getEnableFullScan
Deprecated.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.enable_full_scan is deprecated. See envoy/extensions/load_balancing_policies/least_request/v3/least_request.proto;l=89[#not-implemented-hide:] Unused. Replaced by the `selection_method` enum for better extensibility.
.google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getEnableFullScanin interfaceLeastRequestOrBuilder- Returns:
- The enableFullScan.
-
getEnableFullScanOrBuilder
Deprecated.[#not-implemented-hide:] Unused. Replaced by the `selection_method` enum for better extensibility.
.google.protobuf.BoolValue enable_full_scan = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getEnableFullScanOrBuilderin interfaceLeastRequestOrBuilder
-
getSelectionMethodValue
public int getSelectionMethodValue()Method for selecting the host set from which to return the host with the fewest active requests. Defaults to ``N_CHOICES``.
.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.SelectionMethod selection_method = 6 [(.validate.rules) = { ... }- Specified by:
getSelectionMethodValuein interfaceLeastRequestOrBuilder- Returns:
- The enum numeric value on the wire for selectionMethod.
-
getSelectionMethod
Method for selecting the host set from which to return the host with the fewest active requests. Defaults to ``N_CHOICES``.
.envoy.extensions.load_balancing_policies.least_request.v3.LeastRequest.SelectionMethod selection_method = 6 [(.validate.rules) = { ... }- Specified by:
getSelectionMethodin interfaceLeastRequestOrBuilder- Returns:
- The selectionMethod.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static LeastRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static LeastRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static LeastRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected LeastRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-