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

Class RateLimitConfig.Action.HeaderValueMatch

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action.HeaderValueMatch

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitConfig.Action.HeaderValueMatchOrBuilder, Serializable

Enclosing class:

RateLimitConfig.Action

public static final class RateLimitConfig.Action.HeaderValueMatch
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitConfig.Action.HeaderValueMatchOrBuilder

 The following descriptor entry is appended to the descriptor:
 .. code-block:: cpp
   ("header_match", "<descriptor_value>")
 

Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action.HeaderValueMatch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RateLimitConfig.Action.HeaderValueMatch.Builder	The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	DESCRIPTOR_VALUE_FIELD_NUMBER
static int	EXPECT_MATCH_FIELD_NUMBER
static int	HEADERS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static RateLimitConfig.Action.HeaderValueMatch	getDefaultInstance()
RateLimitConfig.Action.HeaderValueMatch	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDescriptorValue()	The value to use in the descriptor entry.
com.google.protobuf.ByteString	getDescriptorValueBytes()	The value to use in the descriptor entry.
boolean	getExpectMatch()	If set to true, the action will append a descriptor entry when the request matches the headers.
HeaderMatcher	getHeaders(int index)	Specifies a set of headers that the rate limit action should match on.
int	getHeadersCount()	Specifies a set of headers that the rate limit action should match on.
List<HeaderMatcher>	getHeadersList()	Specifies a set of headers that the rate limit action should match on.
HeaderMatcherOrBuilder	getHeadersOrBuilder(int index)	Specifies a set of headers that the rate limit action should match on.
List<? extends HeaderMatcherOrBuilder>	getHeadersOrBuilderList()	Specifies a set of headers that the rate limit action should match on.
com.google.protobuf.Parser<RateLimitConfig.Action.HeaderValueMatch>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RateLimitConfig.Action.HeaderValueMatch.Builder	newBuilder()
static RateLimitConfig.Action.HeaderValueMatch.Builder	newBuilder(RateLimitConfig.Action.HeaderValueMatch prototype)
RateLimitConfig.Action.HeaderValueMatch.Builder	newBuilderForType()
protected RateLimitConfig.Action.HeaderValueMatch.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RateLimitConfig.Action.HeaderValueMatch	parseDelimitedFrom(InputStream input)
static RateLimitConfig.Action.HeaderValueMatch	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(byte[] data)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(com.google.protobuf.ByteString data)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(InputStream input)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(ByteBuffer data)
static RateLimitConfig.Action.HeaderValueMatch	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimitConfig.Action.HeaderValueMatch>	parser()
RateLimitConfig.Action.HeaderValueMatch.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

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

HEADERS_FIELD_NUMBER

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

getDescriptorValue

public String getDescriptorValue()

 The value to use in the descriptor entry.
 

string descriptor_value = 1 [(.validate.rules) = { ... }

Specified by:

getDescriptorValue in interface RateLimitConfig.Action.HeaderValueMatchOrBuilder

Returns:

The descriptorValue.

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 RateLimitConfig.Action.HeaderValueMatchOrBuilder

Returns:

The bytes for descriptorValue.

getExpectMatch

public boolean 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.
 

bool expect_match = 2;

Specified by:

getExpectMatch in interface RateLimitConfig.Action.HeaderValueMatchOrBuilder

Returns:

The expectMatch.

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 RateLimitConfig.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 RateLimitConfig.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 RateLimitConfig.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 RateLimitConfig.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 RateLimitConfig.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 RateLimitConfig.Action.HeaderValueMatch parseFrom(ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(ByteBuffer data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(com.google.protobuf.ByteString data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static RateLimitConfig.Action.HeaderValueMatch parseDelimitedFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static RateLimitConfig.Action.HeaderValueMatch parseDelimitedFrom(InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(com.google.protobuf.CodedInputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static RateLimitConfig.Action.HeaderValueMatch parseFrom(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

newBuilderForType

public RateLimitConfig.Action.HeaderValueMatch.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimitConfig.Action.HeaderValueMatch.Builder newBuilder()

newBuilder

public static RateLimitConfig.Action.HeaderValueMatch.Builder newBuilder(RateLimitConfig.Action.HeaderValueMatch prototype)

toBuilder

public RateLimitConfig.Action.HeaderValueMatch.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RateLimitConfig.Action.HeaderValueMatch.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RateLimitConfig.Action.HeaderValueMatch getDefaultInstance()

parser

public static com.google.protobuf.Parser<RateLimitConfig.Action.HeaderValueMatch> parser()

getParserForType

public com.google.protobuf.Parser<RateLimitConfig.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 RateLimitConfig.Action.HeaderValueMatch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder