Class RingHash

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.load_balancing_policies.ring_hash.v3.RingHash
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RingHashOrBuilder, Serializable
@Generated public final class RingHash extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • HASH_FUNCTION_FIELD_NUMBER

      public static final int HASH_FUNCTION_FIELD_NUMBER
      See Also:

    • hashFunction_

      private int hashFunction_

    • MINIMUM_RING_SIZE_FIELD_NUMBER

      public static final int MINIMUM_RING_SIZE_FIELD_NUMBER
      See Also:

    • minimumRingSize_

      private com.google.protobuf.UInt64Value minimumRingSize_

    • MAXIMUM_RING_SIZE_FIELD_NUMBER

      public static final int MAXIMUM_RING_SIZE_FIELD_NUMBER
      See Also:

    • maximumRingSize_

      private com.google.protobuf.UInt64Value maximumRingSize_

    • USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER

      public static final int USE_HOSTNAME_FOR_HASHING_FIELD_NUMBER
      See Also:

    • useHostnameForHashing_

      private boolean useHostnameForHashing_

    • HASH_BALANCE_FACTOR_FIELD_NUMBER

      public static final int HASH_BALANCE_FACTOR_FIELD_NUMBER
      See Also:

    • hashBalanceFactor_

      private com.google.protobuf.UInt32Value hashBalanceFactor_

    • CONSISTENT_HASHING_LB_CONFIG_FIELD_NUMBER

      public static final int CONSISTENT_HASHING_LB_CONFIG_FIELD_NUMBER
      See Also:

    • consistentHashingLbConfig_

      private ConsistentHashingLbConfig consistentHashingLbConfig_

    • LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER

      public static final int LOCALITY_WEIGHTED_LB_CONFIG_FIELD_NUMBER
      See Also:

    • localityWeightedLbConfig_

      private LocalityLbConfig.LocalityWeightedLbConfig localityWeightedLbConfig_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final RingHash DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<RingHash> PARSER

  • Constructor Details

    • RingHash

      private RingHash(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • RingHash

      private RingHash()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

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

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

    • 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

      @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.

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

    • 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

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

    • getConsistentHashingLbConfigOrBuilder

      public ConsistentHashingLbConfigOrBuilder 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 interface RingHashOrBuilder

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

    • getLocalityWeightedLbConfig

      public LocalityLbConfig.LocalityWeightedLbConfig 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 interface RingHashOrBuilder
      Returns:
      The localityWeightedLbConfig.

    • getLocalityWeightedLbConfigOrBuilder

      public LocalityLbConfig.LocalityWeightedLbConfigOrBuilder 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 interface RingHashOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RingHash parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RingHash parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RingHash parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RingHash parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RingHash parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RingHash parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RingHash parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static RingHash.Builder newBuilder()

    • newBuilder

      public static RingHash.Builder newBuilder(RingHash prototype)

    • toBuilder

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

    • newBuilderForType

      protected RingHash.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RingHash getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RingHash> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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