io.envoyproxy.envoy.config.filter.http.rate_limit.v2

Class RateLimit

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.filter.http.rate_limit.v2.RateLimit

All Implemented Interfaces:

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

public final class RateLimit
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitOrBuilder

 [#next-free-field: 8]
 

Protobuf type envoy.config.filter.http.rate_limit.v2.RateLimit

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimit.Builder [#next-free-field: 8] Protobuf type envoy.config.filter.http.rate_limit.v2.RateLimit

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	DOMAIN_FIELD_NUMBER
static int	FAILURE_MODE_DENY_FIELD_NUMBER
static int	RATE_LIMIT_SERVICE_FIELD_NUMBER
static int	RATE_LIMITED_AS_RESOURCE_EXHAUSTED_FIELD_NUMBER
static int	REQUEST_TYPE_FIELD_NUMBER
static int	STAGE_FIELD_NUMBER
static int	TIMEOUT_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 RateLimit	getDefaultInstance()
RateLimit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDomain() The rate limit domain to use when calling the rate limit service.
com.google.protobuf.ByteString	getDomainBytes() The rate limit domain to use when calling the rate limit service.
boolean	getFailureModeDeny() The filter's behaviour in case the rate limiting service does not respond back.
com.google.protobuf.Parser<RateLimit>	getParserForType()
boolean	getRateLimitedAsResourceExhausted() Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call.
RateLimitServiceConfig	getRateLimitService() Configuration for an external rate limit service provider.
RateLimitServiceConfigOrBuilder	getRateLimitServiceOrBuilder() Configuration for an external rate limit service provider.
String	getRequestType() The type of requests the filter should apply to.
com.google.protobuf.ByteString	getRequestTypeBytes() The type of requests the filter should apply to.
int	getSerializedSize()
int	getStage() Specifies the rate limit configurations to be applied with the same stage number.
com.google.protobuf.Duration	getTimeout() The timeout in milliseconds for the rate limit service RPC.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() The timeout in milliseconds for the rate limit service RPC.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasRateLimitService() Configuration for an external rate limit service provider.
boolean	hasTimeout() The timeout in milliseconds for the rate limit service RPC.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RateLimit.Builder	newBuilder()
static RateLimit.Builder	newBuilder(RateLimit prototype)
RateLimit.Builder	newBuilderForType()
protected RateLimit.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RateLimit	parseDelimitedFrom(InputStream input)
static RateLimit	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit	parseFrom(byte[] data)
static RateLimit	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit	parseFrom(ByteBuffer data)
static RateLimit	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit	parseFrom(com.google.protobuf.ByteString data)
static RateLimit	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit	parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimit	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimit	parseFrom(InputStream input)
static RateLimit	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimit>	parser()
RateLimit.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

STAGE_FIELD_NUMBER

public static final int STAGE_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_TYPE_FIELD_NUMBER

public static final int REQUEST_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER

See Also:

Constant Field Values

FAILURE_MODE_DENY_FIELD_NUMBER

public static final int FAILURE_MODE_DENY_FIELD_NUMBER

See Also:

Constant Field Values

RATE_LIMITED_AS_RESOURCE_EXHAUSTED_FIELD_NUMBER

public static final int RATE_LIMITED_AS_RESOURCE_EXHAUSTED_FIELD_NUMBER

See Also:

Constant Field Values

RATE_LIMIT_SERVICE_FIELD_NUMBER

public static final int RATE_LIMIT_SERVICE_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()

 The rate limit domain to use when calling the rate limit service.
 

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

Specified by:

getDomain in interface RateLimitOrBuilder

getDomainBytes

public com.google.protobuf.ByteString getDomainBytes()

 The rate limit domain to use when calling the rate limit service.
 

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

Specified by:

getDomainBytes in interface RateLimitOrBuilder

getStage

public int getStage()

 Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
 

uint32 stage = 2 [(.validate.rules) = { ... }

Specified by:

getStage in interface RateLimitOrBuilder

getRequestType

public String getRequestType()

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3 [(.validate.rules) = { ... }

Specified by:

getRequestType in interface RateLimitOrBuilder

getRequestTypeBytes

public com.google.protobuf.ByteString getRequestTypeBytes()

 The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
 

string request_type = 3 [(.validate.rules) = { ... }

Specified by:

getRequestTypeBytes in interface RateLimitOrBuilder

hasTimeout

public boolean hasTimeout()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4;

Specified by:

hasTimeout in interface RateLimitOrBuilder

getTimeout

public com.google.protobuf.Duration getTimeout()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4;

Specified by:

getTimeout in interface RateLimitOrBuilder

getTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

 The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
 

.google.protobuf.Duration timeout = 4;

Specified by:

getTimeoutOrBuilder in interface RateLimitOrBuilder

getFailureModeDeny

public boolean getFailureModeDeny()

 The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
 

bool failure_mode_deny = 5;

Specified by:

getFailureModeDeny in interface RateLimitOrBuilder

getRateLimitedAsResourceExhausted

public boolean getRateLimitedAsResourceExhausted()

 Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
 of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call. The
 HTTP code will be 200 for a gRPC response.
 

bool rate_limited_as_resource_exhausted = 6;

Specified by:

getRateLimitedAsResourceExhausted in interface RateLimitOrBuilder

hasRateLimitService

public boolean hasRateLimitService()

 Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
 

.envoy.config.ratelimit.v2.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

Specified by:

hasRateLimitService in interface RateLimitOrBuilder

getRateLimitService

public RateLimitServiceConfig getRateLimitService()

 Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
 

.envoy.config.ratelimit.v2.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

Specified by:

getRateLimitService in interface RateLimitOrBuilder

getRateLimitServiceOrBuilder

public RateLimitServiceConfigOrBuilder getRateLimitServiceOrBuilder()

 Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
 

.envoy.config.ratelimit.v2.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

Specified by:

getRateLimitServiceOrBuilder in interface RateLimitOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RateLimit parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RateLimit parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RateLimit.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RateLimit.Builder newBuilder()

newBuilder

public static RateLimit.Builder newBuilder(RateLimit prototype)

toBuilder

public RateLimit.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RateLimit getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder