Package io.envoyproxy.envoy.extensions.common.ratelimit.v3

Enum XRateLimitHeadersRFCVersion

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<XRateLimitHeadersRFCVersion>
    public enum XRateLimitHeadersRFCVersion
extends Enum<XRateLimitHeadersRFCVersion>
implements com.google.protobuf.ProtocolMessageEnum
     Defines the version of the standard to use for X-RateLimit headers.
    Protobuf enum envoy.extensions.common.ratelimit.v3.XRateLimitHeadersRFCVersion

    • Enum Constant Detail

      • DRAFT_VERSION_03

        public static final XRateLimitHeadersRFCVersion DRAFT_VERSION_03
         Use `draft RFC Version 03 <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_ where 3 headers will be added:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The value is returned by the maximum tokens of the token bucket.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The value is returned by the remaining tokens in the token bucket.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The value is returned by the remaining fill interval of the token bucket.
        DRAFT_VERSION_03 = 1;

    • Field Detail

      • OFF_VALUE

        public static final int OFF_VALUE
         X-RateLimit headers disabled.
        OFF = 0;
        See Also:
        Constant Field Values

      • DRAFT_VERSION_03_VALUE

        public static final int DRAFT_VERSION_03_VALUE
         Use `draft RFC Version 03 <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_ where 3 headers will be added:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The value is returned by the maximum tokens of the token bucket.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The value is returned by the remaining tokens in the token bucket.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The value is returned by the remaining fill interval of the token bucket.
        DRAFT_VERSION_03 = 1;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static XRateLimitHeadersRFCVersion[] 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 (XRateLimitHeadersRFCVersion c : XRateLimitHeadersRFCVersion.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static XRateLimitHeadersRFCVersion 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 XRateLimitHeadersRFCVersion 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 XRateLimitHeadersRFCVersion forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

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