Class RateLimit.Action.RequestHeaders

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.RequestHeadersOrBuilder, java.io.Serializable
    Enclosing class:
    RateLimit.Action

    public static final class RateLimit.Action.RequestHeaders
    extends com.google.protobuf.GeneratedMessage
    implements RateLimit.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.config.route.v3.RateLimit.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
      • headerName_

        private volatile java.lang.Object headerName_
      • DESCRIPTOR_KEY_FIELD_NUMBER

        public static final int DESCRIPTOR_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • descriptorKey_

        private volatile java.lang.Object descriptorKey_
      • SKIP_IF_ABSENT_FIELD_NUMBER

        public static final int SKIP_IF_ABSENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • skipIfAbsent_

        private boolean skipIfAbsent_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • RequestHeaders

        private RequestHeaders​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • RequestHeaders

        private RequestHeaders()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • getHeaderName

        public java.lang.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 RateLimit.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 RateLimit.Action.RequestHeadersOrBuilder
        Returns:
        The bytes for headerName.
      • getDescriptorKeyBytes

        public com.google.protobuf.ByteString getDescriptorKeyBytes()
         The key to use in the descriptor entry.
         
        string descriptor_key = 2 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorKeyBytes in interface RateLimit.Action.RequestHeadersOrBuilder
        Returns:
        The bytes for descriptorKey.
      • 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 RateLimit.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.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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 RateLimit.Action.RequestHeaders parseFrom​(java.nio.ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static RateLimit.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 RateLimit.Action.RequestHeaders parseFrom​(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static RateLimit.Action.RequestHeaders parseFrom​(java.io.InputStream input)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit.Action.RequestHeaders parseFrom​(java.io.InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimit.Action.RequestHeaders parseDelimitedFrom​(java.io.InputStream input)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimit.Action.RequestHeaders parseDelimitedFrom​(java.io.InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit.Action.RequestHeaders parseFrom​(com.google.protobuf.CodedInputStream input)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimit.Action.RequestHeaders parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected RateLimit.Action.RequestHeaders.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getParserForType

        public com.google.protobuf.Parser<RateLimit.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.GeneratedMessage
      • getDefaultInstanceForType

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