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

Class RateLimitConfig.Action.RequestHeaders

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitConfig.Action.RequestHeadersOrBuilder, Serializable
    Enclosing class:
    RateLimitConfig.Action
    public static final class RateLimitConfig.Action.RequestHeaders
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitConfig.Action.RequestHeadersOrBuilder
     The following descriptor entry is appended when a header contains a key that matches the
 ``header_name``:
 .. code-block:: cpp
   ("<descriptor_key>", "<header_value_queried_from_header>")
    Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action.RequestHeaders
    See Also:
    Serialized Form

    • Field Detail

      • HEADER_NAME_FIELD_NUMBER

        public static final int HEADER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTOR_KEY_FIELD_NUMBER

        public static final int DESCRIPTOR_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SKIP_IF_ABSENT_FIELD_NUMBER

        public static final int SKIP_IF_ABSENT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getHeaderName

        public String getHeaderName()
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderName in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The headerName.

      • getHeaderNameBytes

        public com.google.protobuf.ByteString getHeaderNameBytes()
         The header name to be queried from the request headers. The header’s
 value is used to populate the value of the descriptor entry for the
 descriptor_key.
        string header_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderNameBytes in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The bytes for headerName.

      • getSkipIfAbsent

        public boolean getSkipIfAbsent()
         If set to true, Envoy skips the descriptor while calling rate limiting service
 when header is not present in the request. By default it skips calling the
 rate limiting service if this header is not present in the request.
        bool skip_if_absent = 3;
        Specified by:
        getSkipIfAbsent in interface RateLimitConfig.Action.RequestHeadersOrBuilder
        Returns:
        The skipIfAbsent.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RateLimitConfig.Action.RequestHeaders parseFrom​(ByteBuffer data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitConfig.Action.RequestHeaders parseFrom​(com.google.protobuf.ByteString data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitConfig.Action.RequestHeaders parseFrom​(com.google.protobuf.ByteString data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitConfig.Action.RequestHeaders parseFrom​(byte[] data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitConfig.Action.RequestHeaders parseFrom​(byte[] data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public RateLimitConfig.Action.RequestHeaders.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RateLimitConfig.Action.RequestHeaders.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RateLimitConfig.Action.RequestHeaders> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RateLimitConfig.Action.RequestHeaders getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder