Package io.envoyproxy.envoy.service.ratelimit.v3

Enum RateLimitResponse.Code

java.lang.Object

java.lang.Enum<RateLimitResponse.Code>

io.envoyproxy.envoy.service.ratelimit.v3.RateLimitResponse.Code

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RateLimitResponse.Code>

Enclosing class:

RateLimitResponse

public static enum RateLimitResponse.Code
extends Enum<RateLimitResponse.Code>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum envoy.service.ratelimit.v3.RateLimitResponse.Code

Enum Constant Summary

Enum Constants

Enum Constant	Description
OK	The response code to notify that the number of requests are under limit.
OVER_LIMIT	The response code to notify that the number of requests are over limit.
UNKNOWN	The response code is not known.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	OK_VALUE	The response code to notify that the number of requests are under limit.
static int	OVER_LIMIT_VALUE	The response code to notify that the number of requests are over limit.
static int	UNKNOWN_VALUE	The response code is not known.

Method Summary

Modifier and Type	Method	Description
static RateLimitResponse.Code	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<RateLimitResponse.Code>	internalGetValueMap()
static RateLimitResponse.Code	valueOf(int value)	Deprecated.
static RateLimitResponse.Code	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static RateLimitResponse.Code	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RateLimitResponse.Code[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final RateLimitResponse.Code UNKNOWN

 The response code is not known.
 

UNKNOWN = 0;

OK

public static final RateLimitResponse.Code OK

 The response code to notify that the number of requests are under limit.
 

OK = 1;

OVER_LIMIT

public static final RateLimitResponse.Code OVER_LIMIT

 The response code to notify that the number of requests are over limit.
 

OVER_LIMIT = 2;

UNRECOGNIZED

public static final RateLimitResponse.Code UNRECOGNIZED

Field Detail

UNKNOWN_VALUE

public static final int UNKNOWN_VALUE

 The response code is not known.
 

UNKNOWN = 0;

See Also:

Constant Field Values

OK_VALUE

public static final int OK_VALUE

 The response code to notify that the number of requests are under limit.
 

OK = 1;

See Also:

Constant Field Values

OVER_LIMIT_VALUE

public static final int OVER_LIMIT_VALUE

 The response code to notify that the number of requests are over limit.
 

OVER_LIMIT = 2;

See Also:

Constant Field Values

Method Detail

values

public static RateLimitResponse.Code[] 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 (RateLimitResponse.Code c : RateLimitResponse.Code.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RateLimitResponse.Code 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 RateLimitResponse.Code 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 RateLimitResponse.Code 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<RateLimitResponse.Code> 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 RateLimitResponse.Code 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