Class ConsistentHashingLbConfig
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ConsistentHashingLbConfigOrBuilder
,java.io.Serializable
public final class ConsistentHashingLbConfig extends com.google.protobuf.GeneratedMessage implements ConsistentHashingLbConfigOrBuilder
Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
Protobuf typeenvoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConsistentHashingLbConfig.Builder
Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)-
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static ConsistentHashingLbConfig
DEFAULT_INSTANCE
static int
HASH_BALANCE_FACTOR_FIELD_NUMBER
private com.google.protobuf.UInt32Value
hashBalanceFactor_
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<ConsistentHashingLbConfig>
PARSER
private static long
serialVersionUID
static int
USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER
private boolean
useHostnameForHashing_
-
Constructor Summary
Constructors Modifier Constructor Description private
ConsistentHashingLbConfig()
private
ConsistentHashingLbConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static ConsistentHashingLbConfig
getDefaultInstance()
ConsistentHashingLbConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.UInt32Value
getHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host.com.google.protobuf.UInt32ValueOrBuilder
getHashBalanceFactorOrBuilder()
Configures percentage of average cluster load to bound per upstream host.com.google.protobuf.Parser<ConsistentHashingLbConfig>
getParserForType()
int
getSerializedSize()
boolean
getUseHostnameForHashing()
If set to ``true``, the cluster will use hostname instead of the resolved address as the key to consistently hash to an upstream host.boolean
hasHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ConsistentHashingLbConfig.Builder
newBuilder()
static ConsistentHashingLbConfig.Builder
newBuilder(ConsistentHashingLbConfig prototype)
ConsistentHashingLbConfig.Builder
newBuilderForType()
protected ConsistentHashingLbConfig.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ConsistentHashingLbConfig
parseDelimitedFrom(java.io.InputStream input)
static ConsistentHashingLbConfig
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConsistentHashingLbConfig
parseFrom(byte[] data)
static ConsistentHashingLbConfig
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConsistentHashingLbConfig
parseFrom(com.google.protobuf.ByteString data)
static ConsistentHashingLbConfig
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConsistentHashingLbConfig
parseFrom(com.google.protobuf.CodedInputStream input)
static ConsistentHashingLbConfig
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConsistentHashingLbConfig
parseFrom(java.io.InputStream input)
static ConsistentHashingLbConfig
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ConsistentHashingLbConfig
parseFrom(java.nio.ByteBuffer data)
static ConsistentHashingLbConfig
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ConsistentHashingLbConfig>
parser()
ConsistentHashingLbConfig.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER
public static final int USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
useHostnameForHashing_
private boolean useHostnameForHashing_
-
HASH_BALANCE_FACTOR_FIELD_NUMBER
public static final int HASH_BALANCE_FACTOR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
hashBalanceFactor_
private com.google.protobuf.UInt32Value hashBalanceFactor_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final ConsistentHashingLbConfig DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<ConsistentHashingLbConfig> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getUseHostnameForHashing
public boolean getUseHostnameForHashing()
If set to ``true``, the cluster will use hostname instead of the resolved address as the key to consistently hash to an upstream host. Only valid for StrictDNS clusters with hostnames which resolve to a single IP address.
bool use_hostname_for_hashing = 1;
- Specified by:
getUseHostnameForHashing
in interfaceConsistentHashingLbConfigOrBuilder
- Returns:
- The useHostnameForHashing.
-
hasHashBalanceFactor
public boolean hasHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster. If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200. Minimum is 100. Applies to both Ring Hash and Maglev load balancers. This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified ``hash_balance_factor``, requests to any upstream host are capped at ``hash_balance_factor/100`` times the average number of requests across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the cascading overflow effect when choosing the next host in the ring/table). If weights are specified on the hosts, they are respected. This is an O(N) algorithm, unlike other load balancers. Using a lower ``hash_balance_factor`` results in more hosts being probed, so use a higher value if you require better performance.
.google.protobuf.UInt32Value hash_balance_factor = 2 [(.validate.rules) = { ... }
- Specified by:
hasHashBalanceFactor
in interfaceConsistentHashingLbConfigOrBuilder
- Returns:
- Whether the hashBalanceFactor field is set.
-
getHashBalanceFactor
public com.google.protobuf.UInt32Value getHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster. If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200. Minimum is 100. Applies to both Ring Hash and Maglev load balancers. This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified ``hash_balance_factor``, requests to any upstream host are capped at ``hash_balance_factor/100`` times the average number of requests across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the cascading overflow effect when choosing the next host in the ring/table). If weights are specified on the hosts, they are respected. This is an O(N) algorithm, unlike other load balancers. Using a lower ``hash_balance_factor`` results in more hosts being probed, so use a higher value if you require better performance.
.google.protobuf.UInt32Value hash_balance_factor = 2 [(.validate.rules) = { ... }
- Specified by:
getHashBalanceFactor
in interfaceConsistentHashingLbConfigOrBuilder
- Returns:
- The hashBalanceFactor.
-
getHashBalanceFactorOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getHashBalanceFactorOrBuilder()
Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster. If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200. Minimum is 100. Applies to both Ring Hash and Maglev load balancers. This is implemented based on the method described in the paper https://arxiv.org/abs/1608.01350. For the specified ``hash_balance_factor``, requests to any upstream host are capped at ``hash_balance_factor/100`` times the average number of requests across the cluster. When a request arrives for an upstream host that is currently serving at its max capacity, linear probing is used to identify an eligible host. Further, the linear probe is implemented using a random jump in hosts ring/table to identify the eligible host (this technique is as described in the paper https://arxiv.org/abs/1908.08762 - the random jump avoids the cascading overflow effect when choosing the next host in the ring/table). If weights are specified on the hosts, they are respected. This is an O(N) algorithm, unlike other load balancers. Using a lower ``hash_balance_factor`` results in more hosts being probed, so use a higher value if you require better performance.
.google.protobuf.UInt32Value hash_balance_factor = 2 [(.validate.rules) = { ... }
- Specified by:
getHashBalanceFactorOrBuilder
in interfaceConsistentHashingLbConfigOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ConsistentHashingLbConfig parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ConsistentHashingLbConfig parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ConsistentHashingLbConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public ConsistentHashingLbConfig.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ConsistentHashingLbConfig.Builder newBuilder()
-
newBuilder
public static ConsistentHashingLbConfig.Builder newBuilder(ConsistentHashingLbConfig prototype)
-
toBuilder
public ConsistentHashingLbConfig.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ConsistentHashingLbConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static ConsistentHashingLbConfig getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ConsistentHashingLbConfig> parser()
-
getParserForType
public com.google.protobuf.Parser<ConsistentHashingLbConfig> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public ConsistentHashingLbConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-