Interface Cluster.RingHashLbConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Cluster.RingHashLbConfig, Cluster.RingHashLbConfig.Builder
Enclosing class:
Cluster
public static interface Cluster.RingHashLbConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Cluster.RingHashLbConfig.HashFunction
    getHashFunction()
    The hash function used to hash hosts onto the ketama ring.
    int
    getHashFunctionValue()
    The hash function used to hash hosts onto the ketama ring.
    com.google.protobuf.UInt64Value
    getMaximumRingSize()
    Maximum hash ring size.
    com.google.protobuf.UInt64ValueOrBuilder
    getMaximumRingSizeOrBuilder()
    Maximum hash ring size.
    com.google.protobuf.UInt64Value
    getMinimumRingSize()
    Minimum hash ring size.
    com.google.protobuf.UInt64ValueOrBuilder
    getMinimumRingSizeOrBuilder()
    Minimum hash ring size.
    boolean
    hasMaximumRingSize()
    Maximum hash ring size.
    boolean
    hasMinimumRingSize()
    Minimum hash ring size.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasMinimumRingSize

      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 = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the minimumRingSize field is set.

    • getMinimumRingSize

      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 = 1 [(.validate.rules) = { ... }
      Returns:
      The minimumRingSize.

    • getMinimumRingSizeOrBuilder

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

    • getHashFunctionValue

      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.config.cluster.v3.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for hashFunction.

    • getHashFunction

      Cluster.RingHashLbConfig.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.config.cluster.v3.Cluster.RingHashLbConfig.HashFunction hash_function = 3 [(.validate.rules) = { ... }
      Returns:
      The hashFunction.

    • hasMaximumRingSize

      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 = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the maximumRingSize field is set.

    • getMaximumRingSize

      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 = 4 [(.validate.rules) = { ... }
      Returns:
      The maximumRingSize.

    • getMaximumRingSizeOrBuilder

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