public final class RateLimitResponse extends com.google.protobuf.GeneratedMessageV3 implements RateLimitResponseOrBuilder
A response from a ShouldRateLimit call. [#next-free-field: 7]Protobuf type
envoy.service.ratelimit.v3.RateLimitResponse| Modifier and Type | Class and Description |
|---|---|
static class |
RateLimitResponse.Builder
A response from a ShouldRateLimit call.
|
static class |
RateLimitResponse.Code
Protobuf enum
envoy.service.ratelimit.v3.RateLimitResponse.Code |
static class |
RateLimitResponse.DescriptorStatus
Protobuf type
envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus |
static interface |
RateLimitResponse.DescriptorStatusOrBuilder |
static class |
RateLimitResponse.RateLimit
Defines an actual rate limit in terms of requests per unit of time and the unit itself.
|
static interface |
RateLimitResponse.RateLimitOrBuilder |
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| Modifier and Type | Field and Description |
|---|---|
static int |
DYNAMIC_METADATA_FIELD_NUMBER |
static int |
OVERALL_CODE_FIELD_NUMBER |
static int |
RAW_BODY_FIELD_NUMBER |
static int |
REQUEST_HEADERS_TO_ADD_FIELD_NUMBER |
static int |
RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER |
static int |
STATUSES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static RateLimitResponse |
getDefaultInstance() |
RateLimitResponse |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Struct |
getDynamicMetadata()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
filter.
|
com.google.protobuf.StructOrBuilder |
getDynamicMetadataOrBuilder()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
filter.
|
RateLimitResponse.Code |
getOverallCode()
The overall response code which takes into account all of the descriptors that were passed
in the RateLimitRequest message.
|
int |
getOverallCodeValue()
The overall response code which takes into account all of the descriptors that were passed
in the RateLimitRequest message.
|
com.google.protobuf.Parser<RateLimitResponse> |
getParserForType() |
com.google.protobuf.ByteString |
getRawBody()
A response body to send to the downstream client when the response code is not OK.
|
HeaderValue |
getRequestHeadersToAdd(int index)
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; |
int |
getRequestHeadersToAddCount()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; |
List<HeaderValue> |
getRequestHeadersToAddList()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; |
HeaderValueOrBuilder |
getRequestHeadersToAddOrBuilder(int index)
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; |
List<? extends HeaderValueOrBuilder> |
getRequestHeadersToAddOrBuilderList()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4; |
HeaderValue |
getResponseHeadersToAdd(int index)
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; |
int |
getResponseHeadersToAddCount()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; |
List<HeaderValue> |
getResponseHeadersToAddList()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; |
HeaderValueOrBuilder |
getResponseHeadersToAddOrBuilder(int index)
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; |
List<? extends HeaderValueOrBuilder> |
getResponseHeadersToAddOrBuilderList()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3; |
int |
getSerializedSize() |
RateLimitResponse.DescriptorStatus |
getStatuses(int index)
A list of DescriptorStatus messages which matches the length of the descriptor list passed
in the RateLimitRequest.
|
int |
getStatusesCount()
A list of DescriptorStatus messages which matches the length of the descriptor list passed
in the RateLimitRequest.
|
List<RateLimitResponse.DescriptorStatus> |
getStatusesList()
A list of DescriptorStatus messages which matches the length of the descriptor list passed
in the RateLimitRequest.
|
RateLimitResponse.DescriptorStatusOrBuilder |
getStatusesOrBuilder(int index)
A list of DescriptorStatus messages which matches the length of the descriptor list passed
in the RateLimitRequest.
|
List<? extends RateLimitResponse.DescriptorStatusOrBuilder> |
getStatusesOrBuilderList()
A list of DescriptorStatus messages which matches the length of the descriptor list passed
in the RateLimitRequest.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasDynamicMetadata()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next
filter.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RateLimitResponse.Builder |
newBuilder() |
static RateLimitResponse.Builder |
newBuilder(RateLimitResponse prototype) |
RateLimitResponse.Builder |
newBuilderForType() |
protected RateLimitResponse.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RateLimitResponse |
parseDelimitedFrom(InputStream input) |
static RateLimitResponse |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimitResponse |
parseFrom(byte[] data) |
static RateLimitResponse |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimitResponse |
parseFrom(ByteBuffer data) |
static RateLimitResponse |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimitResponse |
parseFrom(com.google.protobuf.ByteString data) |
static RateLimitResponse |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimitResponse |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RateLimitResponse |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RateLimitResponse |
parseFrom(InputStream input) |
static RateLimitResponse |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RateLimitResponse> |
parser() |
RateLimitResponse.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int OVERALL_CODE_FIELD_NUMBER
public static final int STATUSES_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
public static final int RAW_BODY_FIELD_NUMBER
public static final int DYNAMIC_METADATA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getOverallCodeValue()
The overall response code which takes into account all of the descriptors that were passed in the RateLimitRequest message.
.envoy.service.ratelimit.v3.RateLimitResponse.Code overall_code = 1;getOverallCodeValue in interface RateLimitResponseOrBuilderpublic RateLimitResponse.Code getOverallCode()
The overall response code which takes into account all of the descriptors that were passed in the RateLimitRequest message.
.envoy.service.ratelimit.v3.RateLimitResponse.Code overall_code = 1;getOverallCode in interface RateLimitResponseOrBuilderpublic List<RateLimitResponse.DescriptorStatus> getStatusesList()
A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.
repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;getStatusesList in interface RateLimitResponseOrBuilderpublic List<? extends RateLimitResponse.DescriptorStatusOrBuilder> getStatusesOrBuilderList()
A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.
repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;getStatusesOrBuilderList in interface RateLimitResponseOrBuilderpublic int getStatusesCount()
A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.
repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;getStatusesCount in interface RateLimitResponseOrBuilderpublic RateLimitResponse.DescriptorStatus getStatuses(int index)
A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.
repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;getStatuses in interface RateLimitResponseOrBuilderpublic RateLimitResponse.DescriptorStatusOrBuilder getStatusesOrBuilder(int index)
A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.
repeated .envoy.service.ratelimit.v3.RateLimitResponse.DescriptorStatus statuses = 2;getStatusesOrBuilder in interface RateLimitResponseOrBuilderpublic List<HeaderValue> getResponseHeadersToAddList()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;getResponseHeadersToAddList in interface RateLimitResponseOrBuilderpublic List<? extends HeaderValueOrBuilder> getResponseHeadersToAddOrBuilderList()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;getResponseHeadersToAddOrBuilderList in interface RateLimitResponseOrBuilderpublic int getResponseHeadersToAddCount()
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;getResponseHeadersToAddCount in interface RateLimitResponseOrBuilderpublic HeaderValue getResponseHeadersToAdd(int index)
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;getResponseHeadersToAdd in interface RateLimitResponseOrBuilderpublic HeaderValueOrBuilder getResponseHeadersToAddOrBuilder(int index)
A list of headers to add to the response
repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;getResponseHeadersToAddOrBuilder in interface RateLimitResponseOrBuilderpublic List<HeaderValue> getRequestHeadersToAddList()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;getRequestHeadersToAddList in interface RateLimitResponseOrBuilderpublic List<? extends HeaderValueOrBuilder> getRequestHeadersToAddOrBuilderList()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;getRequestHeadersToAddOrBuilderList in interface RateLimitResponseOrBuilderpublic int getRequestHeadersToAddCount()
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;getRequestHeadersToAddCount in interface RateLimitResponseOrBuilderpublic HeaderValue getRequestHeadersToAdd(int index)
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;getRequestHeadersToAdd in interface RateLimitResponseOrBuilderpublic HeaderValueOrBuilder getRequestHeadersToAddOrBuilder(int index)
A list of headers to add to the request when forwarded
repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;getRequestHeadersToAddOrBuilder in interface RateLimitResponseOrBuilderpublic com.google.protobuf.ByteString getRawBody()
A response body to send to the downstream client when the response code is not OK.
bytes raw_body = 5;getRawBody in interface RateLimitResponseOrBuilderpublic boolean hasDynamicMetadata()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter that requires it: - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter. - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter. - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
.google.protobuf.Struct dynamic_metadata = 6;hasDynamicMetadata in interface RateLimitResponseOrBuilderpublic com.google.protobuf.Struct getDynamicMetadata()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter that requires it: - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter. - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter. - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
.google.protobuf.Struct dynamic_metadata = 6;getDynamicMetadata in interface RateLimitResponseOrBuilderpublic com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()
Optional response metadata that will be emitted as dynamic metadata to be consumed by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter that requires it: - :ref:`envoy.filters.http.ratelimit <config_http_filters_ratelimit_dynamic_metadata>` for HTTP filter. - :ref:`envoy.filters.network.ratelimit <config_network_filters_ratelimit_dynamic_metadata>` for network filter. - :ref:`envoy.filters.thrift.rate_limit <config_thrift_filters_rate_limit_dynamic_metadata>` for Thrift filter.
.google.protobuf.Struct dynamic_metadata = 6;getDynamicMetadataOrBuilder in interface RateLimitResponseOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RateLimitResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RateLimitResponse parseFrom(InputStream input) throws IOException
IOExceptionpublic static RateLimitResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RateLimitResponse parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RateLimitResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RateLimitResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RateLimitResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RateLimitResponse.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RateLimitResponse.Builder newBuilder()
public static RateLimitResponse.Builder newBuilder(RateLimitResponse prototype)
public RateLimitResponse.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RateLimitResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RateLimitResponse getDefaultInstance()
public static com.google.protobuf.Parser<RateLimitResponse> parser()
public com.google.protobuf.Parser<RateLimitResponse> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RateLimitResponse getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.