io.envoyproxy.envoy.service.ratelimit.v2

Class RateLimitRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.service.ratelimit.v2.RateLimitRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitRequestOrBuilder, Serializable

public final class RateLimitRequest
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitRequestOrBuilder

 Main message for a rate limit request. The rate limit service is designed to be fully generic
 in the sense that it can operate on arbitrary hierarchical key/value pairs. The loaded
 configuration will parse the request and find the most specific limit to apply. In addition,
 a RateLimitRequest can contain multiple "descriptors" to limit on. When multiple descriptors
 are provided, the server will limit on *ALL* of them and return an OVER_LIMIT response if any
 of them are over limit. This enables more complex application level rate limiting scenarios
 if desired.
 

Protobuf type envoy.service.ratelimit.v2.RateLimitRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimitRequest.Builder Main message for a rate limit request.

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTORS_FIELD_NUMBER
static int	DOMAIN_FIELD_NUMBER
static int	HITS_ADDEND_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 and Description
boolean	equals(Object obj)
static RateLimitRequest	getDefaultInstance()
RateLimitRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RateLimitDescriptor	getDescriptors(int index) All rate limit requests must specify at least one RateLimitDescriptor.
int	getDescriptorsCount() All rate limit requests must specify at least one RateLimitDescriptor.
List<RateLimitDescriptor>	getDescriptorsList() All rate limit requests must specify at least one RateLimitDescriptor.
RateLimitDescriptorOrBuilder	getDescriptorsOrBuilder(int index) All rate limit requests must specify at least one RateLimitDescriptor.
List<? extends RateLimitDescriptorOrBuilder>	getDescriptorsOrBuilderList() All rate limit requests must specify at least one RateLimitDescriptor.
String	getDomain() All rate limit requests must specify a domain.
com.google.protobuf.ByteString	getDomainBytes() All rate limit requests must specify a domain.
int	getHitsAddend() Rate limit requests can optionally specify the number of hits a request adds to the matched limit.
com.google.protobuf.Parser<RateLimitRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RateLimitRequest.Builder	newBuilder()
static RateLimitRequest.Builder	newBuilder(RateLimitRequest prototype)
RateLimitRequest.Builder	newBuilderForType()
protected RateLimitRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RateLimitRequest	parseDelimitedFrom(InputStream input)
static RateLimitRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitRequest	parseFrom(byte[] data)
static RateLimitRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitRequest	parseFrom(ByteBuffer data)
static RateLimitRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitRequest	parseFrom(com.google.protobuf.ByteString data)
static RateLimitRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimitRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitRequest	parseFrom(InputStream input)
static RateLimitRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimitRequest>	parser()
RateLimitRequest.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, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DOMAIN_FIELD_NUMBER

public static final int DOMAIN_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTORS_FIELD_NUMBER

public static final int DESCRIPTORS_FIELD_NUMBER

See Also:

Constant Field Values

HITS_ADDEND_FIELD_NUMBER

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

getDomain

public String getDomain()

 All rate limit requests must specify a domain. This enables the configuration to be per
 application without fear of overlap. E.g., "envoy".
 

string domain = 1;

Specified by:

getDomain in interface RateLimitRequestOrBuilder

getDomainBytes

public com.google.protobuf.ByteString getDomainBytes()

 All rate limit requests must specify a domain. This enables the configuration to be per
 application without fear of overlap. E.g., "envoy".
 

string domain = 1;

Specified by:

getDomainBytes in interface RateLimitRequestOrBuilder

getDescriptorsList

public List<RateLimitDescriptor> getDescriptorsList()

 All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
 

repeated .envoy.api.v2.ratelimit.RateLimitDescriptor descriptors = 2;

Specified by:

getDescriptorsList in interface RateLimitRequestOrBuilder

getDescriptorsOrBuilderList

public List<? extends RateLimitDescriptorOrBuilder> getDescriptorsOrBuilderList()

 All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
 

repeated .envoy.api.v2.ratelimit.RateLimitDescriptor descriptors = 2;

Specified by:

getDescriptorsOrBuilderList in interface RateLimitRequestOrBuilder

getDescriptorsCount

public int getDescriptorsCount()

 All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
 

repeated .envoy.api.v2.ratelimit.RateLimitDescriptor descriptors = 2;

Specified by:

getDescriptorsCount in interface RateLimitRequestOrBuilder

getDescriptors

public RateLimitDescriptor getDescriptors(int index)

 All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
 

repeated .envoy.api.v2.ratelimit.RateLimitDescriptor descriptors = 2;

Specified by:

getDescriptors in interface RateLimitRequestOrBuilder

getDescriptorsOrBuilder

public RateLimitDescriptorOrBuilder getDescriptorsOrBuilder(int index)

 All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
 

repeated .envoy.api.v2.ratelimit.RateLimitDescriptor descriptors = 2;

Specified by:

getDescriptorsOrBuilder in interface RateLimitRequestOrBuilder

getHitsAddend

public int getHitsAddend()

 Rate limit requests can optionally specify the number of hits a request adds to the matched
 limit. If the value is not set in the message, a request increases the matched limit by 1.
 

uint32 hits_addend = 3;

Specified by:

getHitsAddend in interface RateLimitRequestOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitRequest parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitRequest parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitRequest parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitRequest parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RateLimitRequest parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static RateLimitRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RateLimitRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimitRequest.Builder newBuilder()

newBuilder

public static RateLimitRequest.Builder newBuilder(RateLimitRequest prototype)

toBuilder

public RateLimitRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RateLimitRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RateLimitRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<RateLimitRequest> parser()

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder