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

Enum RateLimitPerRoute.OverrideOptions

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RateLimitPerRoute.OverrideOptions>
    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

    • Enum Constant Detail

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

    • Field Detail

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

      • values

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

      • 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