Class RateLimitQuotaBucketSettings.DenyResponseSettings
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.DenyResponseSettings
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
,Serializable
- Enclosing class:
RateLimitQuotaBucketSettings
public static final class RateLimitQuotaBucketSettings.DenyResponseSettings
extends com.google.protobuf.GeneratedMessage
implements RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
Customize the deny response to the requests over the rate limit.Protobuf type
envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.DenyResponseSettings
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Customize the deny response to the requests over the rate limit.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final RateLimitQuotaBucketSettings.DenyResponseSettings
static final int
private com.google.rpc.Status
static final int
static final int
private com.google.protobuf.BytesValue
private HttpStatus
private byte
private static final com.google.protobuf.Parser
<RateLimitQuotaBucketSettings.DenyResponseSettings> static final int
private List
<HeaderValueOption> private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
DenyResponseSettings
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static final com.google.protobuf.Descriptors.Descriptor
com.google.rpc.Status
Configure the deny response for gRPC requests over the rate limit.com.google.rpc.StatusOrBuilder
Configure the deny response for gRPC requests over the rate limit.com.google.protobuf.BytesValue
HTTP response body used to deny for HTTP requests (gRPC excluded).com.google.protobuf.BytesValueOrBuilder
HTTP response body used to deny for HTTP requests (gRPC excluded).HTTP response code to deny for HTTP requests (gRPC excluded).HTTP response code to deny for HTTP requests (gRPC excluded).com.google.protobuf.Parser
<RateLimitQuotaBucketSettings.DenyResponseSettings> getResponseHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.int
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.getResponseHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited.int
boolean
Configure the deny response for gRPC requests over the rate limit.int
hashCode()
boolean
HTTP response body used to deny for HTTP requests (gRPC excluded).boolean
HTTP response code to deny for HTTP requests (gRPC excluded).protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom
(InputStream input) parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(byte[] data) parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.ByteString data) parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(com.google.protobuf.CodedInputStream input) parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(InputStream input) parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom
(ByteBuffer data) parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RateLimitQuotaBucketSettings.DenyResponseSettings> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
HTTP_STATUS_FIELD_NUMBER
public static final int HTTP_STATUS_FIELD_NUMBER- See Also:
-
httpStatus_
-
HTTP_BODY_FIELD_NUMBER
public static final int HTTP_BODY_FIELD_NUMBER- See Also:
-
httpBody_
private com.google.protobuf.BytesValue httpBody_ -
GRPC_STATUS_FIELD_NUMBER
public static final int GRPC_STATUS_FIELD_NUMBER- See Also:
-
grpcStatus_
private com.google.rpc.Status grpcStatus_ -
RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER- See Also:
-
responseHeadersToAdd_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RateLimitQuotaBucketSettings.DenyResponseSettings> PARSER
-
-
Constructor Details
-
DenyResponseSettings
private DenyResponseSettings(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
DenyResponseSettings
private DenyResponseSettings()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
hasHttpStatus
public boolean hasHttpStatus()HTTP response code to deny for HTTP requests (gRPC excluded). Defaults to 429 (:ref:`StatusCode.TooManyRequests<envoy_v3_api_enum_value_type.v3.StatusCode.TooManyRequests>`).
.envoy.type.v3.HttpStatus http_status = 1;
- Specified by:
hasHttpStatus
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- Whether the httpStatus field is set.
-
getHttpStatus
HTTP response code to deny for HTTP requests (gRPC excluded). Defaults to 429 (:ref:`StatusCode.TooManyRequests<envoy_v3_api_enum_value_type.v3.StatusCode.TooManyRequests>`).
.envoy.type.v3.HttpStatus http_status = 1;
- Specified by:
getHttpStatus
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- The httpStatus.
-
getHttpStatusOrBuilder
HTTP response code to deny for HTTP requests (gRPC excluded). Defaults to 429 (:ref:`StatusCode.TooManyRequests<envoy_v3_api_enum_value_type.v3.StatusCode.TooManyRequests>`).
.envoy.type.v3.HttpStatus http_status = 1;
- Specified by:
getHttpStatusOrBuilder
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
hasHttpBody
public boolean hasHttpBody()HTTP response body used to deny for HTTP requests (gRPC excluded). If not set, an empty body is returned.
.google.protobuf.BytesValue http_body = 2;
- Specified by:
hasHttpBody
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- Whether the httpBody field is set.
-
getHttpBody
public com.google.protobuf.BytesValue getHttpBody()HTTP response body used to deny for HTTP requests (gRPC excluded). If not set, an empty body is returned.
.google.protobuf.BytesValue http_body = 2;
- Specified by:
getHttpBody
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- The httpBody.
-
getHttpBodyOrBuilder
public com.google.protobuf.BytesValueOrBuilder getHttpBodyOrBuilder()HTTP response body used to deny for HTTP requests (gRPC excluded). If not set, an empty body is returned.
.google.protobuf.BytesValue http_body = 2;
- Specified by:
getHttpBodyOrBuilder
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
hasGrpcStatus
public boolean hasGrpcStatus()Configure the deny response for gRPC requests over the rate limit. Allows to specify the `RPC status code <https://cloud.google.com/natural-language/docs/reference/rpc/google.rpc#google.rpc.Code>`_, and the error message. Defaults to the Status with the RPC Code ``UNAVAILABLE`` and empty message. To identify gRPC requests, Envoy checks that the ``Content-Type`` header is ``application/grpc``, or one of the various ``application/grpc+`` values. .. note:: The HTTP code for a gRPC response is always 200.
.google.rpc.Status grpc_status = 3;
- Specified by:
hasGrpcStatus
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- Whether the grpcStatus field is set.
-
getGrpcStatus
public com.google.rpc.Status getGrpcStatus()Configure the deny response for gRPC requests over the rate limit. Allows to specify the `RPC status code <https://cloud.google.com/natural-language/docs/reference/rpc/google.rpc#google.rpc.Code>`_, and the error message. Defaults to the Status with the RPC Code ``UNAVAILABLE`` and empty message. To identify gRPC requests, Envoy checks that the ``Content-Type`` header is ``application/grpc``, or one of the various ``application/grpc+`` values. .. note:: The HTTP code for a gRPC response is always 200.
.google.rpc.Status grpc_status = 3;
- Specified by:
getGrpcStatus
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
- Returns:
- The grpcStatus.
-
getGrpcStatusOrBuilder
public com.google.rpc.StatusOrBuilder getGrpcStatusOrBuilder()Configure the deny response for gRPC requests over the rate limit. Allows to specify the `RPC status code <https://cloud.google.com/natural-language/docs/reference/rpc/google.rpc#google.rpc.Code>`_, and the error message. Defaults to the Status with the RPC Code ``UNAVAILABLE`` and empty message. To identify gRPC requests, Envoy checks that the ``Content-Type`` header is ``application/grpc``, or one of the various ``application/grpc+`` values. .. note:: The HTTP code for a gRPC response is always 200.
.google.rpc.Status grpc_status = 3;
- Specified by:
getGrpcStatusOrBuilder
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
getResponseHeadersToAddList
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. Applies both to plain HTTP, and gRPC requests. The headers are added even when the rate limit quota was not enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToAddList
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
getResponseHeadersToAddOrBuilderList
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. Applies both to plain HTTP, and gRPC requests. The headers are added even when the rate limit quota was not enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToAddOrBuilderList
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
getResponseHeadersToAddCount
public int getResponseHeadersToAddCount()Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. Applies both to plain HTTP, and gRPC requests. The headers are added even when the rate limit quota was not enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToAddCount
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
getResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. Applies both to plain HTTP, and gRPC requests. The headers are added even when the rate limit quota was not enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToAdd
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
getResponseHeadersToAddOrBuilder
Specifies a list of HTTP headers that should be added to each response for requests that have been rate limited. Applies both to plain HTTP, and gRPC requests. The headers are added even when the rate limit quota was not enforced.
repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToAddOrBuilder
in interfaceRateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimitQuotaBucketSettings.DenyResponseSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static RateLimitQuotaBucketSettings.DenyResponseSettings.Builder newBuilder(RateLimitQuotaBucketSettings.DenyResponseSettings prototype) -
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimitQuotaBucketSettings.DenyResponseSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
public static com.google.protobuf.Parser<RateLimitQuotaBucketSettings.DenyResponseSettings> parser() -
getParserForType
public com.google.protobuf.Parser<RateLimitQuotaBucketSettings.DenyResponseSettings> getParserForType()- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-