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
,java.io.Serializable
,java.lang.Comparable<Cluster.LbPolicy>
- Enclosing class:
- Cluster
public static enum Cluster.LbPolicy extends java.lang.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 enumenvoy.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 int
CLUSTER_PROVIDED_VALUE
This load balancer type must be specified if the configured cluster provides a cluster specific load balancer.private static com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy>
internalValueMap
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
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 int
MAGLEV_VALUE
Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.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.private int
value
private static Cluster.LbPolicy[]
VALUES
-
Constructor Summary
Constructors Modifier Constructor Description private
LbPolicy(int value)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Cluster.LbPolicy
forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor
getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor
getDescriptorForType()
int
getNumber()
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(java.lang.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.
-
-
-
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;
-
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 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
-
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
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:
- Constant Field Values
-
internalValueMap
private static final com.google.protobuf.Internal.EnumLiteMap<Cluster.LbPolicy> internalValueMap
-
VALUES
private static final Cluster.LbPolicy[] VALUES
-
value
private final int value
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getNumber
public final int getNumber()
- Specified by:
getNumber
in interfacecom.google.protobuf.Internal.EnumLite
- Specified by:
getNumber
in interfacecom.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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 interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-