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, Cloneable
    Enclosing class:
    RingHash
    public static final class RingHash.Builder
extends com.google.protobuf.GeneratedMessageV3.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.
 [#extension: envoy.clusters.lb_policy]
 [#next-free-field: 6]
    Protobuf type envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • setField

        public RingHash.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • clearField

        public RingHash.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • clearOneof

        public RingHash.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • setRepeatedField

        public RingHash.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • addRepeatedField

        public RingHash.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • 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.GeneratedMessageV3.Builder<RingHash.Builder>

      • mergeFrom

        public RingHash.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws 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:
        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

      • 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

      • getUseHostnameForHashing

        public boolean getUseHostnameForHashing()
         If set to `true`, the cluster will use hostname instead of the resolved
 address as the key to consistently hash to an upstream host. Only valid for StrictDNS clusters with hostnames which resolve to a single IP address.
        bool use_hostname_for_hashing = 4;
        Specified by:
        getUseHostnameForHashing in interface RingHashOrBuilder
        Returns:
        The useHostnameForHashing.

      • setUseHostnameForHashing

        public RingHash.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 = 4;
        Parameters:
        value - The useHostnameForHashing to set.
        Returns:
        This builder for chaining.

      • clearUseHostnameForHashing

        public RingHash.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 = 4;
        Returns:
        This builder for chaining.

      • hasHashBalanceFactor

        public boolean hasHashBalanceFactor()
         Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150
 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster.
 If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200.
 Minimum is 100.
 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 = 5 [(.validate.rules) = { ... }
        Specified by:
        hasHashBalanceFactor in interface RingHashOrBuilder
        Returns:
        Whether the hashBalanceFactor field is set.

      • getHashBalanceFactor

        public com.google.protobuf.UInt32Value getHashBalanceFactor()
         Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150
 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster.
 If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200.
 Minimum is 100.
 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 = 5 [(.validate.rules) = { ... }
        Specified by:
        getHashBalanceFactor in interface RingHashOrBuilder
        Returns:
        The hashBalanceFactor.

      • setHashBalanceFactor

        public RingHash.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.
 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 = 5 [(.validate.rules) = { ... }

      • setHashBalanceFactor

        public RingHash.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.
 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 = 5 [(.validate.rules) = { ... }

      • mergeHashBalanceFactor

        public RingHash.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.
 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 = 5 [(.validate.rules) = { ... }

      • clearHashBalanceFactor

        public RingHash.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.
 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 = 5 [(.validate.rules) = { ... }

      • getHashBalanceFactorBuilder

        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.
 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 = 5 [(.validate.rules) = { ... }

      • getHashBalanceFactorOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getHashBalanceFactorOrBuilder()
         Configures percentage of average cluster load to bound per upstream host. For example, with a value of 150
 no upstream host will get a load more than 1.5 times the average load of all the hosts in the cluster.
 If not specified, the load is not bounded for any upstream host. Typical value for this parameter is between 120 and 200.
 Minimum is 100.
 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 = 5 [(.validate.rules) = { ... }
        Specified by:
        getHashBalanceFactorOrBuilder in interface RingHashOrBuilder

      • setUnknownFields

        public final RingHash.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>

      • mergeUnknownFields

        public final RingHash.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RingHash.Builder>