Package io.envoyproxy.envoy.config.route.v3

Class RateLimit.Action.HeaderValueMatch

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.HeaderValueMatchOrBuilder, Serializable
    Enclosing class:
    RateLimit.Action
    public static final class RateLimit.Action.HeaderValueMatch
extends com.google.protobuf.GeneratedMessageV3
implements RateLimit.Action.HeaderValueMatchOrBuilder
     The following descriptor entry is appended to the descriptor:
 .. code-block:: cpp
   ("header_match", "<descriptor_value>")
    Protobuf type envoy.config.route.v3.RateLimit.Action.HeaderValueMatch
    See Also:
    Serialized Form

    • Field Detail

      • DESCRIPTOR_KEY_FIELD_NUMBER

        public static final int DESCRIPTOR_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTOR_VALUE_FIELD_NUMBER

        public static final int DESCRIPTOR_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPECT_MATCH_FIELD_NUMBER

        public static final int EXPECT_MATCH_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

      • getDescriptorKeyBytes

        public com.google.protobuf.ByteString getDescriptorKeyBytes()
         The key to use in the descriptor entry. Defaults to ``header_match``.
        string descriptor_key = 4;
        Specified by:
        getDescriptorKeyBytes in interface RateLimit.Action.HeaderValueMatchOrBuilder
        Returns:
        The bytes for descriptorKey.

      • getDescriptorValueBytes

        public com.google.protobuf.ByteString getDescriptorValueBytes()
         The value to use in the descriptor entry.
        string descriptor_value = 1 [(.validate.rules) = { ... }
        Specified by:
        getDescriptorValueBytes in interface RateLimit.Action.HeaderValueMatchOrBuilder
        Returns:
        The bytes for descriptorValue.

      • hasExpectMatch

        public boolean hasExpectMatch()
         If set to true, the action will append a descriptor entry when the
 request matches the headers. If set to false, the action will append a
 descriptor entry when the request does not match the headers. The
 default value is true.
        .google.protobuf.BoolValue expect_match = 2;
        Specified by:
        hasExpectMatch in interface RateLimit.Action.HeaderValueMatchOrBuilder
        Returns:
        Whether the expectMatch field is set.

      • getExpectMatch

        public com.google.protobuf.BoolValue getExpectMatch()
         If set to true, the action will append a descriptor entry when the
 request matches the headers. If set to false, the action will append a
 descriptor entry when the request does not match the headers. The
 default value is true.
        .google.protobuf.BoolValue expect_match = 2;
        Specified by:
        getExpectMatch in interface RateLimit.Action.HeaderValueMatchOrBuilder
        Returns:
        The expectMatch.

      • getExpectMatchOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getExpectMatchOrBuilder()
         If set to true, the action will append a descriptor entry when the
 request matches the headers. If set to false, the action will append a
 descriptor entry when the request does not match the headers. The
 default value is true.
        .google.protobuf.BoolValue expect_match = 2;
        Specified by:
        getExpectMatchOrBuilder in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • getHeadersList

        public List<HeaderMatcher> getHeadersList()
         Specifies a set of headers that the rate limit action should match
 on. The action will check the request’s headers against all the
 specified headers in the config. A match will happen if all the
 headers in the config are present in the request with the same values
 (or based on presence if the value field is not in the config).
        repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
        Specified by:
        getHeadersList in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • getHeadersOrBuilderList

        public List<? extends HeaderMatcherOrBuilder> getHeadersOrBuilderList()
         Specifies a set of headers that the rate limit action should match
 on. The action will check the request’s headers against all the
 specified headers in the config. A match will happen if all the
 headers in the config are present in the request with the same values
 (or based on presence if the value field is not in the config).
        repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
        Specified by:
        getHeadersOrBuilderList in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • getHeadersCount

        public int getHeadersCount()
         Specifies a set of headers that the rate limit action should match
 on. The action will check the request’s headers against all the
 specified headers in the config. A match will happen if all the
 headers in the config are present in the request with the same values
 (or based on presence if the value field is not in the config).
        repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
        Specified by:
        getHeadersCount in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • getHeaders

        public HeaderMatcher getHeaders​(int index)
         Specifies a set of headers that the rate limit action should match
 on. The action will check the request’s headers against all the
 specified headers in the config. A match will happen if all the
 headers in the config are present in the request with the same values
 (or based on presence if the value field is not in the config).
        repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
        Specified by:
        getHeaders in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • getHeadersOrBuilder

        public HeaderMatcherOrBuilder getHeadersOrBuilder​(int index)
         Specifies a set of headers that the rate limit action should match
 on. The action will check the request’s headers against all the
 specified headers in the config. A match will happen if all the
 headers in the config are present in the request with the same values
 (or based on presence if the value field is not in the config).
        repeated .envoy.config.route.v3.HeaderMatcher headers = 3 [(.validate.rules) = { ... }
        Specified by:
        getHeadersOrBuilder in interface RateLimit.Action.HeaderValueMatchOrBuilder

      • 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 RateLimit.Action.HeaderValueMatch parseFrom​(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<RateLimit.Action.HeaderValueMatch> 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 RateLimit.Action.HeaderValueMatch getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder