Class RingHash.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<RingHash.Builder>
com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>
io.envoyproxy.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RingHashOrBuilder
,Cloneable
- Enclosing class:
RingHash
public static final class RingHash.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>
implements RingHashOrBuilder
This configuration allows the built-in RING_HASH 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: 8]Protobuf type
envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private ConsistentHashingLbConfig
private com.google.protobuf.SingleFieldBuilder
<ConsistentHashingLbConfig, ConsistentHashingLbConfig.Builder, ConsistentHashingLbConfigOrBuilder> private com.google.protobuf.UInt32Value
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder> private int
private com.google.protobuf.SingleFieldBuilder
<LocalityLbConfig.LocalityWeightedLbConfig, LocalityLbConfig.LocalityWeightedLbConfig.Builder, LocalityLbConfig.LocalityWeightedLbConfigOrBuilder> private com.google.protobuf.UInt64Value
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt64Value, com.google.protobuf.UInt64Value.Builder, com.google.protobuf.UInt64ValueOrBuilder> private com.google.protobuf.UInt64Value
private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt64Value, com.google.protobuf.UInt64Value.Builder, com.google.protobuf.UInt64ValueOrBuilder> private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
buildPartial0
(RingHash result) clear()
Common configuration for hashing-based load balancing policies.Deprecated.The hash function used to hash hosts onto the ketama ring.Enable locality weighted load balancing for ring hash lb explicitly.Maximum hash ring size.Minimum hash ring size.Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated.Common configuration for hashing-based load balancing policies.Common configuration for hashing-based load balancing policies.private com.google.protobuf.SingleFieldBuilder
<ConsistentHashingLbConfig, ConsistentHashingLbConfig.Builder, ConsistentHashingLbConfigOrBuilder> Common configuration for hashing-based load balancing policies.Common configuration for hashing-based load balancing policies.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.UInt32Value
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.hash_balance_factor is deprecated.com.google.protobuf.UInt32Value.Builder
Deprecated.private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder> Configures percentage of average cluster load to bound per upstream host.com.google.protobuf.UInt32ValueOrBuilder
Deprecated.The hash function used to hash hosts onto the ketama ring.int
The hash function used to hash hosts onto the ketama ring.Enable locality weighted load balancing for ring hash lb explicitly.Enable locality weighted load balancing for ring hash lb explicitly.private com.google.protobuf.SingleFieldBuilder
<LocalityLbConfig.LocalityWeightedLbConfig, LocalityLbConfig.LocalityWeightedLbConfig.Builder, LocalityLbConfig.LocalityWeightedLbConfigOrBuilder> Enable locality weighted load balancing for ring hash lb explicitly.Enable locality weighted load balancing for ring hash lb explicitly.com.google.protobuf.UInt64Value
Maximum hash ring size.com.google.protobuf.UInt64Value.Builder
Maximum hash ring size.private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt64Value, com.google.protobuf.UInt64Value.Builder, com.google.protobuf.UInt64ValueOrBuilder> Maximum hash ring size.com.google.protobuf.UInt64ValueOrBuilder
Maximum hash ring size.com.google.protobuf.UInt64Value
Minimum hash ring size.com.google.protobuf.UInt64Value.Builder
Minimum hash ring size.private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.UInt64Value, com.google.protobuf.UInt64Value.Builder, com.google.protobuf.UInt64ValueOrBuilder> Minimum hash ring size.com.google.protobuf.UInt64ValueOrBuilder
Minimum hash ring size.boolean
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated.boolean
Common configuration for hashing-based load balancing policies.boolean
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.hash_balance_factor is deprecated.boolean
Enable locality weighted load balancing for ring hash lb explicitly.boolean
Maximum hash ring size.boolean
Minimum hash ring size.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
private void
Common configuration for hashing-based load balancing policies.mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeHashBalanceFactor
(com.google.protobuf.UInt32Value value) Deprecated.Enable locality weighted load balancing for ring hash lb explicitly.mergeMaximumRingSize
(com.google.protobuf.UInt64Value value) Maximum hash ring size.mergeMinimumRingSize
(com.google.protobuf.UInt64Value value) Minimum hash ring size.Common configuration for hashing-based load balancing policies.setConsistentHashingLbConfig
(ConsistentHashingLbConfig.Builder builderForValue) Common configuration for hashing-based load balancing policies.setHashBalanceFactor
(com.google.protobuf.UInt32Value value) Deprecated.setHashBalanceFactor
(com.google.protobuf.UInt32Value.Builder builderForValue) Deprecated.The hash function used to hash hosts onto the ketama ring.setHashFunctionValue
(int value) The hash function used to hash hosts onto the ketama ring.Enable locality weighted load balancing for ring hash lb explicitly.Enable locality weighted load balancing for ring hash lb explicitly.setMaximumRingSize
(com.google.protobuf.UInt64Value value) Maximum hash ring size.setMaximumRingSize
(com.google.protobuf.UInt64Value.Builder builderForValue) Maximum hash ring size.setMinimumRingSize
(com.google.protobuf.UInt64Value value) Minimum hash ring size.setMinimumRingSize
(com.google.protobuf.UInt64Value.Builder builderForValue) Minimum hash ring size.setUseHostnameForHashing
(boolean value) Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
hashFunction_
private int hashFunction_ -
minimumRingSize_
private com.google.protobuf.UInt64Value minimumRingSize_ -
minimumRingSizeBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,com.google.protobuf.UInt64Value.Builder, minimumRingSizeBuilder_com.google.protobuf.UInt64ValueOrBuilder> -
maximumRingSize_
private com.google.protobuf.UInt64Value maximumRingSize_ -
maximumRingSizeBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,com.google.protobuf.UInt64Value.Builder, maximumRingSizeBuilder_com.google.protobuf.UInt64ValueOrBuilder> -
useHostnameForHashing_
private boolean useHostnameForHashing_ -
hashBalanceFactor_
private com.google.protobuf.UInt32Value hashBalanceFactor_ -
hashBalanceFactorBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,com.google.protobuf.UInt32Value.Builder, hashBalanceFactorBuilder_com.google.protobuf.UInt32ValueOrBuilder> -
consistentHashingLbConfig_
-
consistentHashingLbConfigBuilder_
private com.google.protobuf.SingleFieldBuilder<ConsistentHashingLbConfig,ConsistentHashingLbConfig.Builder, consistentHashingLbConfigBuilder_ConsistentHashingLbConfigOrBuilder> -
localityWeightedLbConfig_
-
localityWeightedLbConfigBuilder_
private com.google.protobuf.SingleFieldBuilder<LocalityLbConfig.LocalityWeightedLbConfig,LocalityLbConfig.LocalityWeightedLbConfig.Builder, localityWeightedLbConfigBuilder_LocalityLbConfig.LocalityWeightedLbConfigOrBuilder>
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
Method Details
-
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.Builder<RingHash.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RingHash.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>
-
mergeFrom
public RingHash.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<RingHash.Builder>
- Throws:
IOException
-
getHashFunctionValue
public int getHashFunctionValue()The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
- Specified by:
getHashFunctionValue
in interfaceRingHashOrBuilder
- Returns:
- The enum numeric value on the wire for hashFunction.
-
setHashFunctionValue
The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The enum numeric value on the wire for hashFunction to set.- Returns:
- This builder for chaining.
-
getHashFunction
The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
- Specified by:
getHashFunction
in interfaceRingHashOrBuilder
- Returns:
- The hashFunction.
-
setHashFunction
The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The hashFunction to set.- Returns:
- This builder for chaining.
-
clearHashFunction
The hash function used to hash hosts onto the ketama ring. The value defaults to :ref:`XX_HASH<envoy_v3_api_enum_value_config.cluster.v3.Cluster.RingHashLbConfig.HashFunction.XX_HASH>`.
.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.HashFunction hash_function = 1 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
hasMinimumRingSize
public boolean hasMinimumRingSize()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
- Specified by:
hasMinimumRingSize
in interfaceRingHashOrBuilder
- Returns:
- Whether the minimumRingSize field is set.
-
getMinimumRingSize
public com.google.protobuf.UInt64Value getMinimumRingSize()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
- Specified by:
getMinimumRingSize
in interfaceRingHashOrBuilder
- Returns:
- The minimumRingSize.
-
setMinimumRingSize
Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
setMinimumRingSize
Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
mergeMinimumRingSize
Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
clearMinimumRingSize
Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
getMinimumRingSizeBuilder
public com.google.protobuf.UInt64Value.Builder getMinimumRingSizeBuilder()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
getMinimumRingSizeOrBuilder
public com.google.protobuf.UInt64ValueOrBuilder getMinimumRingSizeOrBuilder()Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
- Specified by:
getMinimumRingSizeOrBuilder
in interfaceRingHashOrBuilder
-
getMinimumRingSizeFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,com.google.protobuf.UInt64Value.Builder, getMinimumRingSizeFieldBuilder()com.google.protobuf.UInt64ValueOrBuilder> Minimum hash ring size. The larger the ring is (that is, the more hashes there are for each provided host) the better the request distribution will reflect the desired weights. Defaults to 1024 entries, and limited to 8M entries. See also :ref:`maximum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.maximum_ring_size>`.
.google.protobuf.UInt64Value minimum_ring_size = 2 [(.validate.rules) = { ... }
-
hasMaximumRingSize
public boolean hasMaximumRingSize()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
- Specified by:
hasMaximumRingSize
in interfaceRingHashOrBuilder
- Returns:
- Whether the maximumRingSize field is set.
-
getMaximumRingSize
public com.google.protobuf.UInt64Value getMaximumRingSize()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
- Specified by:
getMaximumRingSize
in interfaceRingHashOrBuilder
- Returns:
- The maximumRingSize.
-
setMaximumRingSize
Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
setMaximumRingSize
Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
mergeMaximumRingSize
Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
clearMaximumRingSize
Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
getMaximumRingSizeBuilder
public com.google.protobuf.UInt64Value.Builder getMaximumRingSizeBuilder()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
getMaximumRingSizeOrBuilder
public com.google.protobuf.UInt64ValueOrBuilder getMaximumRingSizeOrBuilder()Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
- Specified by:
getMaximumRingSizeOrBuilder
in interfaceRingHashOrBuilder
-
getMaximumRingSizeFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,com.google.protobuf.UInt64Value.Builder, getMaximumRingSizeFieldBuilder()com.google.protobuf.UInt64ValueOrBuilder> Maximum hash ring size. Defaults to 8M entries, and limited to 8M entries, but can be lowered to further constrain resource use. See also :ref:`minimum_ring_size<envoy_v3_api_field_config.cluster.v3.Cluster.RingHashLbConfig.minimum_ring_size>`.
.google.protobuf.UInt64Value maximum_ring_size = 3 [(.validate.rules) = { ... }
-
getUseHostnameForHashing
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated. See envoy/extensions/load_balancing_policies/ring_hash/v3/ring_hash.proto;l=62If 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
bool use_hostname_for_hashing = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
getUseHostnameForHashing
in interfaceRingHashOrBuilder
- Returns:
- The useHostnameForHashing.
-
setUseHostnameForHashing
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated. See envoy/extensions/load_balancing_policies/ring_hash/v3/ring_hash.proto;l=62If 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
bool use_hostname_for_hashing = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Parameters:
value
- The useHostnameForHashing to set.- Returns:
- This builder for chaining.
-
clearUseHostnameForHashing
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.use_hostname_for_hashing is deprecated. See envoy/extensions/load_balancing_policies/ring_hash/v3/ring_hash.proto;l=62If 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
bool use_hostname_for_hashing = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- This builder for chaining.
-
hasHashBalanceFactor
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.hash_balance_factor is deprecated. See envoy/extensions/load_balancing_policies/ring_hash/v3/ring_hash.proto;l=85Configures 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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
- Specified by:
hasHashBalanceFactor
in interfaceRingHashOrBuilder
- Returns:
- Whether the hashBalanceFactor field is set.
-
getHashBalanceFactor
Deprecated.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash.hash_balance_factor is deprecated. See envoy/extensions/load_balancing_policies/ring_hash/v3/ring_hash.proto;l=85Configures 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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
- Specified by:
getHashBalanceFactor
in interfaceRingHashOrBuilder
- Returns:
- The hashBalanceFactor.
-
setHashBalanceFactor
Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
setHashBalanceFactor
@Deprecated public RingHash.Builder setHashBalanceFactor(com.google.protobuf.UInt32Value.Builder builderForValue) Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
mergeHashBalanceFactor
Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
clearHashBalanceFactor
Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
getHashBalanceFactorBuilder
Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
getHashBalanceFactorOrBuilder
Deprecated.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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
- Specified by:
getHashBalanceFactorOrBuilder
in interfaceRingHashOrBuilder
-
getHashBalanceFactorFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,com.google.protobuf.UInt32Value.Builder, getHashBalanceFactorFieldBuilder()com.google.protobuf.UInt32ValueOrBuilder> 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. 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. .. note:: This is deprecated and please use :ref:`consistent_hashing_lb_config <envoy_v3_api_field_extensions.load_balancing_policies.ring_hash.v3.RingHash.consistent_hashing_lb_config>` instead.
.google.protobuf.UInt32Value hash_balance_factor = 5 [deprecated = true, (.validate.rules) = { ... }
-
hasConsistentHashingLbConfig
public boolean hasConsistentHashingLbConfig()Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
- Specified by:
hasConsistentHashingLbConfig
in interfaceRingHashOrBuilder
- Returns:
- Whether the consistentHashingLbConfig field is set.
-
getConsistentHashingLbConfig
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
- Specified by:
getConsistentHashingLbConfig
in interfaceRingHashOrBuilder
- Returns:
- The consistentHashingLbConfig.
-
setConsistentHashingLbConfig
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
setConsistentHashingLbConfig
public RingHash.Builder setConsistentHashingLbConfig(ConsistentHashingLbConfig.Builder builderForValue) Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
mergeConsistentHashingLbConfig
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
clearConsistentHashingLbConfig
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
getConsistentHashingLbConfigBuilder
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
getConsistentHashingLbConfigOrBuilder
Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
- Specified by:
getConsistentHashingLbConfigOrBuilder
in interfaceRingHashOrBuilder
-
getConsistentHashingLbConfigFieldBuilder
private com.google.protobuf.SingleFieldBuilder<ConsistentHashingLbConfig,ConsistentHashingLbConfig.Builder, getConsistentHashingLbConfigFieldBuilder()ConsistentHashingLbConfigOrBuilder> Common configuration for hashing-based load balancing policies.
.envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;
-
hasLocalityWeightedLbConfig
public boolean hasLocalityWeightedLbConfig()Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
- Specified by:
hasLocalityWeightedLbConfig
in interfaceRingHashOrBuilder
- Returns:
- Whether the localityWeightedLbConfig field is set.
-
getLocalityWeightedLbConfig
Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
- Specified by:
getLocalityWeightedLbConfig
in interfaceRingHashOrBuilder
- Returns:
- The localityWeightedLbConfig.
-
setLocalityWeightedLbConfig
public RingHash.Builder setLocalityWeightedLbConfig(LocalityLbConfig.LocalityWeightedLbConfig value) Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-
setLocalityWeightedLbConfig
public RingHash.Builder setLocalityWeightedLbConfig(LocalityLbConfig.LocalityWeightedLbConfig.Builder builderForValue) Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-
mergeLocalityWeightedLbConfig
public RingHash.Builder mergeLocalityWeightedLbConfig(LocalityLbConfig.LocalityWeightedLbConfig value) Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-
clearLocalityWeightedLbConfig
Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-
getLocalityWeightedLbConfigBuilder
Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-
getLocalityWeightedLbConfigOrBuilder
Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
- Specified by:
getLocalityWeightedLbConfigOrBuilder
in interfaceRingHashOrBuilder
-
getLocalityWeightedLbConfigFieldBuilder
private com.google.protobuf.SingleFieldBuilder<LocalityLbConfig.LocalityWeightedLbConfig,LocalityLbConfig.LocalityWeightedLbConfig.Builder, getLocalityWeightedLbConfigFieldBuilder()LocalityLbConfig.LocalityWeightedLbConfigOrBuilder> Enable locality weighted load balancing for ring hash lb explicitly.
.envoy.extensions.load_balancing_policies.common.v3.LocalityLbConfig.LocalityWeightedLbConfig locality_weighted_lb_config = 7;
-