Package io.envoyproxy.envoy.api.v2

Enum 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.api.v2.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
      [#not-implemented-hide:] Use the new :ref:`load_balancing_policy <envoy_api_field_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.
      ORIGINAL_DST_LB
      Deprecated.
      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 int CLUSTER_PROVIDED_VALUE
      This load balancer type must be specified if the configured cluster provides a cluster specific load balancer.
      static int LEAST_REQUEST_VALUE
      Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.
      static int LOAD_BALANCING_POLICY_CONFIG_VALUE
      [#not-implemented-hide:] Use the new :ref:`load_balancing_policy <envoy_api_field_Cluster.load_balancing_policy>` field to determine the LB policy.
      static int MAGLEV_VALUE
      Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.
      static int ORIGINAL_DST_LB_VALUE
      Deprecated.
      static int RANDOM_VALUE
      Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.
      static int RING_HASH_VALUE
      Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.
      static int ROUND_ROBIN_VALUE
      Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation.

    • Enum Constant Detail

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

      • ORIGINAL_DST_LB

        @Deprecated
public static final Cluster.LbPolicy ORIGINAL_DST_LB
        Deprecated.
         Refer to the :ref:`original destination load balancing
 policy<arch_overview_load_balancing_types_original_destination>`
 for an explanation.
 .. attention::
   **This load balancing policy is deprecated**. Use CLUSTER_PROVIDED instead.
        ORIGINAL_DST_LB = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];

      • 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
         [#not-implemented-hide:] Use the new :ref:`load_balancing_policy
 <envoy_api_field_Cluster.load_balancing_policy>` field to determine the LB policy.
 [#next-major-version: In the v3 API, we should consider deprecating the lb_policy field
 and instead using the new load_balancing_policy field as the one and only mechanism for
 configuring this.]
        LOAD_BALANCING_POLICY_CONFIG = 7;

    • Field Detail

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • ORIGINAL_DST_LB_VALUE

        @Deprecated
public static final int ORIGINAL_DST_LB_VALUE
        Deprecated.
         Refer to the :ref:`original destination load balancing
 policy<arch_overview_load_balancing_types_original_destination>`
 for an explanation.
 .. attention::
   **This load balancing policy is deprecated**. Use CLUSTER_PROVIDED instead.
        ORIGINAL_DST_LB = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • LOAD_BALANCING_POLICY_CONFIG_VALUE

        public static final int LOAD_BALANCING_POLICY_CONFIG_VALUE
         [#not-implemented-hide:] Use the new :ref:`load_balancing_policy
 <envoy_api_field_Cluster.load_balancing_policy>` field to determine the LB policy.
 [#next-major-version: In the v3 API, we should consider deprecating the lb_policy field
 and instead using the new load_balancing_policy field as the one and only mechanism for
 configuring this.]
        LOAD_BALANCING_POLICY_CONFIG = 7;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static Cluster.LbPolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Cluster.LbPolicy c : Cluster.LbPolicy.values())
    System.out.println(c);
        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 final 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