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.config.cluster.v3.Cluster.LbPolicy
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThis load balancer type must be specified if the configured cluster provides a cluster specific load balancer.Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.Use the new :ref:`load_balancing_policy <envoy_v3_api_field_config.cluster.v3.Cluster.load_balancing_policy>` field to determine the LB policy.Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
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> static final int
Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.static final int
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
Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.static final int
Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.static final int
Refer to the :ref:`ring hash load balancing policy<arch_overview_load_balancing_types_ring_hash>` for an explanation.static final int
Refer to the :ref:`round robin load balancing policy<arch_overview_load_balancing_types_round_robin>` for an explanation.private final int
private static final Cluster.LbPolicy[]
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Cluster.LbPolicy
forNumber
(int value) static final com.google.protobuf.Descriptors.EnumDescriptor
final com.google.protobuf.Descriptors.EnumDescriptor
final int
final com.google.protobuf.Descriptors.EnumValueDescriptor
static com.google.protobuf.Internal.EnumLiteMap
<Cluster.LbPolicy> 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
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 Details
-
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
Refer to the :ref:`least request load balancing policy<arch_overview_load_balancing_types_least_request>` for an explanation.
LEAST_REQUEST = 1;
-
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
Refer to the :ref:`random load balancing policy<arch_overview_load_balancing_types_random>` for an explanation.
RANDOM = 3;
-
MAGLEV
Refer to the :ref:`Maglev load balancing policy<arch_overview_load_balancing_types_maglev>` for an explanation.
MAGLEV = 5;
-
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
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
-
-
Field Details
-
ROUND_ROBIN_VALUE
public static final int ROUND_ROBIN_VALUERefer 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_VALUERefer 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_VALUERefer 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_VALUERefer 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_VALUERefer 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_VALUEThis 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_VALUEUse 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
-
VALUES
-
value
private final int value
-
-
Constructor Details
-
LbPolicy
private LbPolicy(int value)
-
-
Method Details
-
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
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 nameNullPointerException
- 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.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 nameNullPointerException
- if the argument is null
-
forNumber
- Parameters:
value
- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
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
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 nameNullPointerException
- if the argument is null
-