public static final class Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder> implements Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilder
Common Configuration for all consistent hashing load balancers (MaglevLb, RingHashLb, etc.)Protobuf type
envoy.config.cluster.v4alpha.Cluster.CommonLbConfig.ConsistentHashingLbConfig| Modifier and Type | Method and Description |
|---|---|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig |
build() |
Cluster.CommonLbConfig.ConsistentHashingLbConfig |
buildPartial() |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clear() |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clearHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host.
|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clearUseHostnameForHashing()
If set to `true`, the cluster will use hostname instead of the resolved
address as the key to consistently hash to an upstream host.
|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
clone() |
Cluster.CommonLbConfig.ConsistentHashingLbConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
com.google.protobuf.UInt32Value |
getHashBalanceFactor()
Configures percentage of average cluster load to bound per upstream host.
|
com.google.protobuf.UInt32Value.Builder |
getHashBalanceFactorBuilder()
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.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
mergeFrom(Cluster.CommonLbConfig.ConsistentHashingLbConfig other) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
mergeFrom(com.google.protobuf.Message other) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
mergeHashBalanceFactor(com.google.protobuf.UInt32Value value)
Configures percentage of average cluster load to bound per upstream host.
|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setHashBalanceFactor(com.google.protobuf.UInt32Value.Builder builderForValue)
Configures percentage of average cluster load to bound per upstream host.
|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setHashBalanceFactor(com.google.protobuf.UInt32Value value)
Configures percentage of average cluster load to bound per upstream host.
|
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder |
setUseHostnameForHashing(boolean value)
If set to `true`, the cluster will use hostname instead of the resolved
address as the key to consistently hash to an upstream host.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Cluster.CommonLbConfig.ConsistentHashingLbConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Cluster.CommonLbConfig.ConsistentHashingLbConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder mergeFrom(Cluster.CommonLbConfig.ConsistentHashingLbConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>IOExceptionpublic 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;getUseHostnameForHashing in interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilderpublic Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setUseHostnameForHashing(boolean value)
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;public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clearUseHostnameForHashing()
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;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) = { ... }hasHashBalanceFactor in interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilderpublic 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) = { ... }getHashBalanceFactor in interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilderpublic Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setHashBalanceFactor(com.google.protobuf.UInt32Value value)
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) = { ... }public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setHashBalanceFactor(com.google.protobuf.UInt32Value.Builder builderForValue)
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) = { ... }public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder mergeHashBalanceFactor(com.google.protobuf.UInt32Value value)
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) = { ... }public Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder clearHashBalanceFactor()
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) = { ... }public com.google.protobuf.UInt32Value.Builder getHashBalanceFactorBuilder()
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) = { ... }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) = { ... }getHashBalanceFactorOrBuilder in interface Cluster.CommonLbConfig.ConsistentHashingLbConfigOrBuilderpublic final Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>public final Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Cluster.CommonLbConfig.ConsistentHashingLbConfig.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.