Enum Cluster.LbPolicy

java.lang.Object
java.lang.Enum<Cluster.LbPolicy>
io.envoyproxy.envoy.config.cluster.v3.Cluster.LbPolicy
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Cluster.LbPolicy>
Enclosing class:
Cluster
public static enum Cluster.LbPolicy extends Enum<Cluster.LbPolicy> implements com.google.protobuf.ProtocolMessageEnum
Refer to :ref:`load balancer type <arch_overview_load_balancing_types>` architecture
overview section for information on each type.
Protobuf enum envoy.config.cluster.v3.Cluster.LbPolicy

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CLUSTER_PROVIDED
    This load balancer type must be specified if the configured cluster provides a cluster specific load balancer.
    LEAST_REQUEST
    Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.
    LOAD_BALANCING_POLICY_CONFIG
    Use the new :ref:`load_balancing_policy <envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.
    MAGLEV
    Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.
    RANDOM
    Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.
    RING_HASH
    Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.
    ROUND_ROBIN
    Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLUSTER_PROVIDED_VALUE
    This load balancer type must be specified if the configured cluster provides a cluster specific load balancer.
    private static final com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy>
    internalValueMap
     
    static final int
    LEAST_REQUEST_VALUE
    Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.
    static final int
    LOAD_BALANCING_POLICY_CONFIG_VALUE
    Use the new :ref:`load_balancing_policy <envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.
    static final int
    MAGLEV_VALUE
    Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.
    static final int
    RANDOM_VALUE
    Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.
    static final int
    RING_HASH_VALUE
    Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.
    static final int
    ROUND_ROBIN_VALUE
    Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation.
    private final int
    value
     
    private static final Cluster.LbPolicy[]
    VALUES
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    LbPolicy(int value)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Cluster.LbPolicy
    forNumber(int value)
     
    static com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy>
    internalGetValueMap()
     
    static Cluster.LbPolicy
    valueOf(int value)
    Deprecated.
    static Cluster.LbPolicy
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    static Cluster.LbPolicy
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Cluster.LbPolicy[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ROUND_ROBIN

      public static final Cluster.LbPolicy ROUND_ROBIN
      Refer to the :ref:`round robin load balancing
policy<arch_overview_load_balancing_types_round_robin>`
for an explanation.
      ROUND_ROBIN = 0;

    • LEAST_REQUEST

      public static final Cluster.LbPolicy LEAST_REQUEST
      Refer to the :ref:`least request load balancing
policy<arch_overview_load_balancing_types_least_request>`
for an explanation.
      LEAST_REQUEST = 1;

    • RING_HASH

      public static final Cluster.LbPolicy RING_HASH
      Refer to the :ref:`ring hash load balancing
policy<arch_overview_load_balancing_types_ring_hash>`
for an explanation.
      RING_HASH = 2;

    • RANDOM

      public static final Cluster.LbPolicy RANDOM
      Refer to the :ref:`random load balancing
policy<arch_overview_load_balancing_types_random>`
for an explanation.
      RANDOM = 3;

    • MAGLEV

      public static final Cluster.LbPolicy MAGLEV
      Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>`
for an explanation.
      MAGLEV = 5;

    • CLUSTER_PROVIDED

      public static final Cluster.LbPolicy CLUSTER_PROVIDED
      This load balancer type must be specified if the configured cluster provides a cluster
specific load balancer. Consult the configured cluster's documentation for whether to set
this option or not.
      CLUSTER_PROVIDED = 6;

    • LOAD_BALANCING_POLICY_CONFIG

      public static final Cluster.LbPolicy LOAD_BALANCING_POLICY_CONFIG
      Use the new :ref:`load_balancing_policy
<envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.
This has been deprecated in favor of using the :ref:`load_balancing_policy
<envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field without
setting any value in :ref:`lb_policy<envoy_v3_api_field_config.cluster.v3.Cluster.lb_policy>`.
      LOAD_BALANCING_POLICY_CONFIG = 7;

    • UNRECOGNIZED

      public static final Cluster.LbPolicy UNRECOGNIZED

  • Field Details

    • ROUND_ROBIN_VALUE

      public static final int ROUND_ROBIN_VALUE
      Refer to the :ref:`round robin load balancing
policy<arch_overview_load_balancing_types_round_robin>`
for an explanation.
      ROUND_ROBIN = 0;
      See Also:

    • LEAST_REQUEST_VALUE

      public static final int LEAST_REQUEST_VALUE
      Refer to the :ref:`least request load balancing
policy<arch_overview_load_balancing_types_least_request>`
for an explanation.
      LEAST_REQUEST = 1;
      See Also:

    • RING_HASH_VALUE

      public static final int RING_HASH_VALUE
      Refer to the :ref:`ring hash load balancing
policy<arch_overview_load_balancing_types_ring_hash>`
for an explanation.
      RING_HASH = 2;
      See Also:

    • RANDOM_VALUE

      public static final int RANDOM_VALUE
      Refer to the :ref:`random load balancing
policy<arch_overview_load_balancing_types_random>`
for an explanation.
      RANDOM = 3;
      See Also:

    • MAGLEV_VALUE

      public static final int MAGLEV_VALUE
      Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>`
for an explanation.
      MAGLEV = 5;
      See Also:

    • CLUSTER_PROVIDED_VALUE

      public static final int CLUSTER_PROVIDED_VALUE
      This load balancer type must be specified if the configured cluster provides a cluster
specific load balancer. Consult the configured cluster's documentation for whether to set
this option or not.
      CLUSTER_PROVIDED = 6;
      See Also:

    • LOAD_BALANCING_POLICY_CONFIG_VALUE

      public static final int LOAD_BALANCING_POLICY_CONFIG_VALUE
      Use the new :ref:`load_balancing_policy
<envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.
This has been deprecated in favor of using the :ref:`load_balancing_policy
<envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field without
setting any value in :ref:`lb_policy<envoy_v3_api_field_config.cluster.v3.Cluster.lb_policy>`.
      LOAD_BALANCING_POLICY_CONFIG = 7;
      See Also:

    • internalValueMap

      private static final com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy> internalValueMap

    • VALUES

      private static final Cluster.LbPolicy[] VALUES

    • value

      private final int value

  • Constructor Details

    • LbPolicy

      private LbPolicy(int value)

  • Method Details

    • values

      public static Cluster.LbPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Cluster.LbPolicy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static Cluster.LbPolicy valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static Cluster.LbPolicy forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Cluster.LbPolicy valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null