public static final class RateLimit.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder> implements RateLimitOrBuilder
[#next-free-field: 8]Protobuf type
envoy.config.filter.http.rate_limit.v2.RateLimit| Modifier and Type | Method and Description |
|---|---|
RateLimit.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RateLimit |
build() |
RateLimit |
buildPartial() |
RateLimit.Builder |
clear() |
RateLimit.Builder |
clearDomain()
The rate limit domain to use when calling the rate limit service.
|
RateLimit.Builder |
clearFailureModeDeny()
The filter's behaviour in case the rate limiting service does
not respond back.
|
RateLimit.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
RateLimit.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
RateLimit.Builder |
clearRateLimitedAsResourceExhausted()
Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call.
|
RateLimit.Builder |
clearRateLimitService()
Configuration for an external rate limit service provider.
|
RateLimit.Builder |
clearRequestType()
The type of requests the filter should apply to.
|
RateLimit.Builder |
clearStage()
Specifies the rate limit configurations to be applied with the same
stage number.
|
RateLimit.Builder |
clearTimeout()
The timeout in milliseconds for the rate limit service RPC.
|
RateLimit.Builder |
clone() |
RateLimit |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
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.
|
RateLimitServiceConfig.Builder |
getRateLimitServiceBuilder()
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 |
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.Duration.Builder |
getTimeoutBuilder()
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.
|
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() |
RateLimit.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
RateLimit.Builder |
mergeFrom(com.google.protobuf.Message other) |
RateLimit.Builder |
mergeFrom(RateLimit other) |
RateLimit.Builder |
mergeRateLimitService(RateLimitServiceConfig value)
Configuration for an external rate limit service provider.
|
RateLimit.Builder |
mergeTimeout(com.google.protobuf.Duration value)
The timeout in milliseconds for the rate limit service RPC.
|
RateLimit.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
RateLimit.Builder |
setDomain(String value)
The rate limit domain to use when calling the rate limit service.
|
RateLimit.Builder |
setDomainBytes(com.google.protobuf.ByteString value)
The rate limit domain to use when calling the rate limit service.
|
RateLimit.Builder |
setFailureModeDeny(boolean value)
The filter's behaviour in case the rate limiting service does
not respond back.
|
RateLimit.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
RateLimit.Builder |
setRateLimitedAsResourceExhausted(boolean value)
Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call.
|
RateLimit.Builder |
setRateLimitService(RateLimitServiceConfig.Builder builderForValue)
Configuration for an external rate limit service provider.
|
RateLimit.Builder |
setRateLimitService(RateLimitServiceConfig value)
Configuration for an external rate limit service provider.
|
RateLimit.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
RateLimit.Builder |
setRequestType(String value)
The type of requests the filter should apply to.
|
RateLimit.Builder |
setRequestTypeBytes(com.google.protobuf.ByteString value)
The type of requests the filter should apply to.
|
RateLimit.Builder |
setStage(int value)
Specifies the rate limit configurations to be applied with the same
stage number.
|
RateLimit.Builder |
setTimeout(com.google.protobuf.Duration.Builder builderForValue)
The timeout in milliseconds for the rate limit service RPC.
|
RateLimit.Builder |
setTimeout(com.google.protobuf.Duration value)
The timeout in milliseconds for the rate limit service RPC.
|
RateLimit.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic RateLimit build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic RateLimit buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic RateLimit.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Builder>public RateLimit.Builder mergeFrom(RateLimit other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public RateLimit.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Builder>IOExceptionpublic String getDomain()
The rate limit domain to use when calling the rate limit service.
string domain = 1 [(.validate.rules) = { ... }getDomain in interface RateLimitOrBuilderpublic com.google.protobuf.ByteString getDomainBytes()
The rate limit domain to use when calling the rate limit service.
string domain = 1 [(.validate.rules) = { ... }getDomainBytes in interface RateLimitOrBuilderpublic RateLimit.Builder setDomain(String value)
The rate limit domain to use when calling the rate limit service.
string domain = 1 [(.validate.rules) = { ... }public RateLimit.Builder clearDomain()
The rate limit domain to use when calling the rate limit service.
string domain = 1 [(.validate.rules) = { ... }public RateLimit.Builder setDomainBytes(com.google.protobuf.ByteString value)
The rate limit domain to use when calling the rate limit service.
string domain = 1 [(.validate.rules) = { ... }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) = { ... }getStage in interface RateLimitOrBuilderpublic RateLimit.Builder setStage(int value)
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) = { ... }public RateLimit.Builder clearStage()
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) = { ... }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) = { ... }getRequestType in interface RateLimitOrBuilderpublic 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) = { ... }getRequestTypeBytes in interface RateLimitOrBuilderpublic RateLimit.Builder setRequestType(String value)
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) = { ... }public RateLimit.Builder clearRequestType()
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) = { ... }public RateLimit.Builder setRequestTypeBytes(com.google.protobuf.ByteString value)
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) = { ... }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;hasTimeout in interface RateLimitOrBuilderpublic 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;getTimeout in interface RateLimitOrBuilderpublic RateLimit.Builder setTimeout(com.google.protobuf.Duration value)
The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.
.google.protobuf.Duration timeout = 4;public RateLimit.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)
The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.
.google.protobuf.Duration timeout = 4;public RateLimit.Builder mergeTimeout(com.google.protobuf.Duration value)
The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.
.google.protobuf.Duration timeout = 4;public RateLimit.Builder clearTimeout()
The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.
.google.protobuf.Duration timeout = 4;public com.google.protobuf.Duration.Builder getTimeoutBuilder()
The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.
.google.protobuf.Duration timeout = 4;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;getTimeoutOrBuilder in interface RateLimitOrBuilderpublic 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;getFailureModeDeny in interface RateLimitOrBuilderpublic RateLimit.Builder setFailureModeDeny(boolean value)
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;public RateLimit.Builder clearFailureModeDeny()
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;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;getRateLimitedAsResourceExhausted in interface RateLimitOrBuilderpublic RateLimit.Builder setRateLimitedAsResourceExhausted(boolean value)
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;public RateLimit.Builder clearRateLimitedAsResourceExhausted()
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;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) = { ... }hasRateLimitService in interface RateLimitOrBuilderpublic 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) = { ... }getRateLimitService in interface RateLimitOrBuilderpublic RateLimit.Builder setRateLimitService(RateLimitServiceConfig value)
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) = { ... }public RateLimit.Builder setRateLimitService(RateLimitServiceConfig.Builder builderForValue)
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) = { ... }public RateLimit.Builder mergeRateLimitService(RateLimitServiceConfig value)
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) = { ... }public RateLimit.Builder clearRateLimitService()
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) = { ... }public RateLimitServiceConfig.Builder getRateLimitServiceBuilder()
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) = { ... }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) = { ... }getRateLimitServiceOrBuilder in interface RateLimitOrBuilderpublic final RateLimit.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>public final RateLimit.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.