java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.service.ratelimit.v3.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.v3.RateLimitRequest

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class 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
- 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 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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(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 RateLimitRequest`	`parseFrom(ByteBuffer data)`
`static RateLimitRequest`	`parseFrom(ByteBuffer data, 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, 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
- 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
Returns:: The domain.

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
Returns:: The bytes for domain.