Package io.envoyproxy.envoy.extensions.load_balancing_policies.ring_hash.v3

Class RingHash.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RingHashOrBuilder, java.lang.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 Detail

      • 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,​com.google.protobuf.UInt64ValueOrBuilder> minimumRingSizeBuilder_

      • maximumRingSize_

        private com.google.protobuf.UInt64Value maximumRingSize_

      • maximumRingSizeBuilder_

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,​com.google.protobuf.UInt64Value.Builder,​com.google.protobuf.UInt64ValueOrBuilder> maximumRingSizeBuilder_

      • 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,​com.google.protobuf.UInt32ValueOrBuilder> hashBalanceFactorBuilder_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>

      • maybeForceBuilderInitialization

        private void maybeForceBuilderInitialization()

      • clear

        public RingHash.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>

      • getDefaultInstanceForType

        public RingHash getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public RingHash build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public RingHash buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • buildPartial0

        private void buildPartial0​(RingHash result)

      • mergeFrom

        public RingHash.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RingHash.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RingHash.Builder>

      • mergeFrom

        public RingHash.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RingHash.Builder>
        Throws:
        java.io.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 interface RingHashOrBuilder
        Returns:
        The enum numeric value on the wire for hashFunction.

      • setHashFunctionValue

        public RingHash.Builder setHashFunctionValue​(int value)
         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

        public RingHash.HashFunction 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 interface RingHashOrBuilder
        Returns:
        The hashFunction.

      • setHashFunction

        public RingHash.Builder setHashFunction​(RingHash.HashFunction value)
         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

        public RingHash.Builder 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 interface RingHashOrBuilder
        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 interface RingHashOrBuilder
        Returns:
        The minimumRingSize.

      • setMinimumRingSize

        public RingHash.Builder setMinimumRingSize​(com.google.protobuf.UInt64Value value)
         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

        public RingHash.Builder setMinimumRingSize​(com.google.protobuf.UInt64Value.Builder builderForValue)
         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

        public RingHash.Builder mergeMinimumRingSize​(com.google.protobuf.UInt64Value value)
         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

        public RingHash.Builder 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 interface RingHashOrBuilder

      • getMinimumRingSizeFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,​com.google.protobuf.UInt64Value.Builder,​com.google.protobuf.UInt64ValueOrBuilder> getMinimumRingSizeFieldBuilder()
         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 interface RingHashOrBuilder
        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 interface RingHashOrBuilder
        Returns:
        The maximumRingSize.

      • setMaximumRingSize

        public RingHash.Builder setMaximumRingSize​(com.google.protobuf.UInt64Value value)
         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

        public RingHash.Builder setMaximumRingSize​(com.google.protobuf.UInt64Value.Builder builderForValue)
         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

        public RingHash.Builder mergeMaximumRingSize​(com.google.protobuf.UInt64Value value)
         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

        public RingHash.Builder 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 interface RingHashOrBuilder

      • getMaximumRingSizeFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt64Value,​com.google.protobuf.UInt64Value.Builder,​com.google.protobuf.UInt64ValueOrBuilder> getMaximumRingSizeFieldBuilder()
         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
public boolean 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=62
         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.

 .. 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 interface RingHashOrBuilder
        Returns:
        The useHostnameForHashing.

      • setUseHostnameForHashing

        @Deprecated
public RingHash.Builder setUseHostnameForHashing​(boolean value)
        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=62
         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.

 .. 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
public RingHash.Builder 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=62
         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.

 .. 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
public boolean 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=85
         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:
        hasHashBalanceFactor in interface RingHashOrBuilder
        Returns:
        Whether the hashBalanceFactor field is set.

      • getHashBalanceFactor

        @Deprecated
public com.google.protobuf.UInt32Value 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=85
         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:
        getHashBalanceFactor in interface RingHashOrBuilder
        Returns:
        The hashBalanceFactor.

      • setHashBalanceFactor

        @Deprecated
public RingHash.Builder setHashBalanceFactor​(com.google.protobuf.UInt32Value value)
        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
public RingHash.Builder mergeHashBalanceFactor​(com.google.protobuf.UInt32Value value)
        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
public RingHash.Builder 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
public com.google.protobuf.UInt32Value.Builder 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
public com.google.protobuf.UInt32ValueOrBuilder 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 interface RingHashOrBuilder

      • getHashBalanceFactorFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,​com.google.protobuf.UInt32Value.Builder,​com.google.protobuf.UInt32ValueOrBuilder> getHashBalanceFactorFieldBuilder()
         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 interface RingHashOrBuilder
        Returns:
        Whether the consistentHashingLbConfig field is set.

      • getConsistentHashingLbConfig

        public ConsistentHashingLbConfig 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 interface RingHashOrBuilder
        Returns:
        The consistentHashingLbConfig.

      • setConsistentHashingLbConfig

        public RingHash.Builder setConsistentHashingLbConfig​(ConsistentHashingLbConfig value)
         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

        public RingHash.Builder mergeConsistentHashingLbConfig​(ConsistentHashingLbConfig value)
         Common configuration for hashing-based load balancing policies.
        .envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;

      • clearConsistentHashingLbConfig

        public RingHash.Builder clearConsistentHashingLbConfig()
         Common configuration for hashing-based load balancing policies.
        .envoy.extensions.load_balancing_policies.common.v3.ConsistentHashingLbConfig consistent_hashing_lb_config = 6;

      • getConsistentHashingLbConfigBuilder

        public ConsistentHashingLbConfig.Builder getConsistentHashingLbConfigBuilder()
         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 interface RingHashOrBuilder
        Returns:
        Whether the localityWeightedLbConfig field is set.

      • 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

        public RingHash.Builder 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

        public LocalityLbConfig.LocalityWeightedLbConfig.Builder 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;