io.envoyproxy.envoy.config.cluster.v4alpha

Class Cluster.CommonLbConfig.ConsistentHashingLbConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.cluster.v4alpha.Cluster.CommonLbConfig.ConsistentHashingLbConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder, Serializable

Enclosing class:

Cluster.CommonLbConfig

public static final class Cluster.CommonLbConfig.ConsistentHashingLbConfig
extends com.google.protobuf.GeneratedMessageV3
implements Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder

 Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)
 

Protobuf type envoy.config.cluster.v4alpha.Cluster.CommonLbConfig.ConsistentHashingLbConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HASH_BALANCE_FACTOR_FIELD_NUMBER
static int	USE_HOSTNAME_FOR_HASHING_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	getDefaultInstance()
Cluster.CommonLbConfig.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<Cluster.CommonLbConfig.ConsistentHashingLbConfig>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder	newBuilder()
static Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder	newBuilder(Cluster.CommonLbConfig.ConsistentHashingLbConfig prototype)
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder	newBuilderForType()
protected Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseDelimitedFrom(InputStream input)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(byte[] data)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(ByteBuffer data)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(com.google.protobuf.ByteString data)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(InputStream input)
static Cluster.CommonLbConfig.ConsistentHashingLbConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster.CommonLbConfig.ConsistentHashingLbConfig>	parser()
Cluster.CommonLbConfig.ConsistentHashingLbConfig.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, 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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER

public static final int USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER

See Also:

Constant Field Values

HASH_BALANCE_FACTOR_FIELD_NUMBER

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

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 interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder

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 interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder

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 interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder

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 interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder

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 Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(ByteBuffer data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(ByteBuffer data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(com.google.protobuf.ByteString data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.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 Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(byte[] data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(byte[] data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseDelimitedFrom(InputStream input)
                                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseDelimitedFrom(InputStream input,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

newBuilderForType

public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder newBuilder()

newBuilder

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder newBuilder(Cluster.CommonLbConfig.ConsistentHashingLbConfig prototype)

toBuilder

public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster.CommonLbConfig.ConsistentHashingLbConfig getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Cluster.CommonLbConfig.ConsistentHashingLbConfig> 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 Cluster.CommonLbConfig.ConsistentHashingLbConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder