Package io.envoyproxy.envoy.extensions.filters.http.ratelimit.v3

Enum RateLimitPerRoute.OverrideOptions

java.lang.Object

java.lang.Enum<RateLimitPerRoute.OverrideOptions>

io.envoyproxy.envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RateLimitPerRoute.OverrideOptions>, java.lang.constant.Constable

Enclosing class:

RateLimitPerRoute

public static enum RateLimitPerRoute.OverrideOptions
extends Enum<RateLimitPerRoute.OverrideOptions>
implements com.google.protobuf.ProtocolMessageEnum

 The override option determines how the filter handles the cases where there is an override config at a more specific level than this one (from least to most specific: virtual host, route, cluster weight).
 [#not-implemented-hide:]
 

Protobuf enum envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Client-defined default, typically OVERRIDE_POLICY.
IGNORE_POLICY	If there is an override config at a more specific level, ignore it and use only this one.
INCLUDE_POLICY	If there is an override config at a more specific level, use data from both.
OVERRIDE_POLICY	If there is an override config at a more specific level, use that instead of this one.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_VALUE	Client-defined default, typically OVERRIDE_POLICY.
static final int	IGNORE_POLICY_VALUE	If there is an override config at a more specific level, ignore it and use only this one.
static final int	INCLUDE_POLICY_VALUE	If there is an override config at a more specific level, use data from both.
static final int	OVERRIDE_POLICY_VALUE	If there is an override config at a more specific level, use that instead of this one.

Method Summary

Modifier and Type	Method	Description
static RateLimitPerRoute.OverrideOptions	forNumber(int value)
static final 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<RateLimitPerRoute.OverrideOptions>	internalGetValueMap()
static RateLimitPerRoute.OverrideOptions	valueOf(int value)	Deprecated.
static RateLimitPerRoute.OverrideOptions	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static RateLimitPerRoute.OverrideOptions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RateLimitPerRoute.OverrideOptions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final RateLimitPerRoute.OverrideOptions DEFAULT

 Client-defined default, typically OVERRIDE_POLICY. If VhRateLimitsOptions is set, that will be used instead.
 

DEFAULT = 0;

OVERRIDE_POLICY

public static final RateLimitPerRoute.OverrideOptions OVERRIDE_POLICY

 If there is an override config at a more specific level, use that instead of this one.
 

OVERRIDE_POLICY = 1;

INCLUDE_POLICY

public static final RateLimitPerRoute.OverrideOptions INCLUDE_POLICY

 If there is an override config at a more specific level, use data from both.
 

INCLUDE_POLICY = 2;

IGNORE_POLICY

public static final RateLimitPerRoute.OverrideOptions IGNORE_POLICY

 If there is an override config at a more specific level, ignore it and use only this one.
 

IGNORE_POLICY = 3;

UNRECOGNIZED

public static final RateLimitPerRoute.OverrideOptions UNRECOGNIZED

Field Details

DEFAULT_VALUE

public static final int DEFAULT_VALUE

 Client-defined default, typically OVERRIDE_POLICY. If VhRateLimitsOptions is set, that will be used instead.
 

DEFAULT = 0;

See Also:

• Constant Field Values

OVERRIDE_POLICY_VALUE

public static final int OVERRIDE_POLICY_VALUE

 If there is an override config at a more specific level, use that instead of this one.
 

OVERRIDE_POLICY = 1;

See Also:

• Constant Field Values

INCLUDE_POLICY_VALUE

public static final int INCLUDE_POLICY_VALUE

 If there is an override config at a more specific level, use data from both.
 

INCLUDE_POLICY = 2;

See Also:

• Constant Field Values

IGNORE_POLICY_VALUE

public static final int IGNORE_POLICY_VALUE

 If there is an override config at a more specific level, ignore it and use only this one.
 

IGNORE_POLICY = 3;

See Also:

• Constant Field Values

Method Details

values

public static RateLimitPerRoute.OverrideOptions[] 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 RateLimitPerRoute.OverrideOptions 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 RateLimitPerRoute.OverrideOptions 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 RateLimitPerRoute.OverrideOptions 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<RateLimitPerRoute.OverrideOptions> 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 RateLimitPerRoute.OverrideOptions 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