io.envoyproxy.envoy.extensions.common.ratelimit.v3

Class RateLimitDescriptor

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.common.ratelimit.v3.RateLimitDescriptor

All Implemented Interfaces:

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

public final class RateLimitDescriptor
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitDescriptorOrBuilder

 A RateLimitDescriptor is a list of hierarchical entries that are used by the service to
 determine the final rate limit key and overall allowed limit. Here are some examples of how
 they might be used for the domain "envoy".
 .. code-block:: cpp
   ["authenticated": "false"], ["remote_address": "10.0.0.1"]
 What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The
 configuration supplies a default limit for the *remote_address* key. If there is a desire to
 raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the
 configuration.
 .. code-block:: cpp
   ["authenticated": "false"], ["path": "/foo/bar"]
 What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if
 configured that way in the service).
 .. code-block:: cpp
   ["authenticated": "false"], ["path": "/foo/bar"], ["remote_address": "10.0.0.1"]
 What it does: Limits unauthenticated traffic to a specific path for a specific IP address.
 Like (1) we can raise/block specific IP addresses if we want with an override configuration.
 .. code-block:: cpp
   ["authenticated": "true"], ["client_id": "foo"]
 What it does: Limits all traffic for an authenticated client "foo"
 .. code-block:: cpp
   ["authenticated": "true"], ["client_id": "foo"], ["path": "/foo/bar"]
 What it does: Limits traffic to a specific path for an authenticated client "foo"
 The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired.
 This enables building complex application scenarios with a generic backend.
 Optionally the descriptor can contain a limit override under a "limit" key, that specifies
 the number of requests per unit to use instead of the number configured in the
 rate limiting service.
 

Protobuf type envoy.extensions.common.ratelimit.v3.RateLimitDescriptor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimitDescriptor.Builder A RateLimitDescriptor is a list of hierarchical entries that are used by the service to determine the final rate limit key and overall allowed limit.
static class	RateLimitDescriptor.Entry Protobuf type envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry
static interface	RateLimitDescriptor.EntryOrBuilder
static class	RateLimitDescriptor.RateLimitOverride Override rate limit to apply to this descriptor instead of the limit configured in the rate limit service.
static interface	RateLimitDescriptor.RateLimitOverrideOrBuilder

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	ENTRIES_FIELD_NUMBER
static int	LIMIT_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 RateLimitDescriptor	getDefaultInstance()
RateLimitDescriptor	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RateLimitDescriptor.Entry	getEntries(int index) Descriptor entries.
int	getEntriesCount() Descriptor entries.
List<RateLimitDescriptor.Entry>	getEntriesList() Descriptor entries.
RateLimitDescriptor.EntryOrBuilder	getEntriesOrBuilder(int index) Descriptor entries.
List<? extends RateLimitDescriptor.EntryOrBuilder>	getEntriesOrBuilderList() Descriptor entries.
RateLimitDescriptor.RateLimitOverride	getLimit() Optional rate limit override to supply to the ratelimit service.
RateLimitDescriptor.RateLimitOverrideOrBuilder	getLimitOrBuilder() Optional rate limit override to supply to the ratelimit service.
com.google.protobuf.Parser<RateLimitDescriptor>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasLimit() Optional rate limit override to supply to the ratelimit service.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RateLimitDescriptor.Builder	newBuilder()
static RateLimitDescriptor.Builder	newBuilder(RateLimitDescriptor prototype)
RateLimitDescriptor.Builder	newBuilderForType()
protected RateLimitDescriptor.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RateLimitDescriptor	parseDelimitedFrom(InputStream input)
static RateLimitDescriptor	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitDescriptor	parseFrom(byte[] data)
static RateLimitDescriptor	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitDescriptor	parseFrom(ByteBuffer data)
static RateLimitDescriptor	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitDescriptor	parseFrom(com.google.protobuf.ByteString data)
static RateLimitDescriptor	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitDescriptor	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimitDescriptor	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitDescriptor	parseFrom(InputStream input)
static RateLimitDescriptor	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimitDescriptor>	parser()
RateLimitDescriptor.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

ENTRIES_FIELD_NUMBER

public static final int ENTRIES_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

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

getEntriesList

public List<RateLimitDescriptor.Entry> getEntriesList()

 Descriptor entries.
 

repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

Specified by:

getEntriesList in interface RateLimitDescriptorOrBuilder

getEntriesOrBuilderList

public List<? extends RateLimitDescriptor.EntryOrBuilder> getEntriesOrBuilderList()

 Descriptor entries.
 

repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

Specified by:

getEntriesOrBuilderList in interface RateLimitDescriptorOrBuilder

getEntriesCount

public int getEntriesCount()

 Descriptor entries.
 

repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

Specified by:

getEntriesCount in interface RateLimitDescriptorOrBuilder

getEntries

public RateLimitDescriptor.Entry getEntries(int index)

 Descriptor entries.
 

repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

Specified by:

getEntries in interface RateLimitDescriptorOrBuilder

getEntriesOrBuilder

public RateLimitDescriptor.EntryOrBuilder getEntriesOrBuilder(int index)

 Descriptor entries.
 

repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry entries = 1 [(.validate.rules) = { ... }

Specified by:

getEntriesOrBuilder in interface RateLimitDescriptorOrBuilder

hasLimit

public boolean hasLimit()

 Optional rate limit override to supply to the ratelimit service.
 

.envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;

Specified by:

hasLimit in interface RateLimitDescriptorOrBuilder

getLimit

public RateLimitDescriptor.RateLimitOverride getLimit()

 Optional rate limit override to supply to the ratelimit service.
 

.envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;

Specified by:

getLimit in interface RateLimitDescriptorOrBuilder

getLimitOrBuilder

public RateLimitDescriptor.RateLimitOverrideOrBuilder getLimitOrBuilder()

 Optional rate limit override to supply to the ratelimit service.
 

.envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride limit = 2;

Specified by:

getLimitOrBuilder in interface RateLimitDescriptorOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimitDescriptor parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RateLimitDescriptor parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RateLimitDescriptor.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimitDescriptor.Builder newBuilder()

newBuilder

public static RateLimitDescriptor.Builder newBuilder(RateLimitDescriptor prototype)

toBuilder

public RateLimitDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RateLimitDescriptor getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder