Package io.envoyproxy.envoy.extensions.filters.http.rate_limit_quota.v3

Class RateLimitQuotaBucketSettings.DenyResponseSettings

    • Field Detail

      • HTTP_STATUS_FIELD_NUMBER

        public static final int HTTP_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GRPC_STATUS_FIELD_NUMBER

        public static final int GRPC_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER

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

      • 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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
        Returns:
        Whether the httpStatus field is set.

      • 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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
        Returns:
        Whether the grpcStatus field is set.

      • getGrpcStatus

        public 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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder
        Returns:
        The grpcStatus.

      • getGrpcStatusOrBuilder

        public 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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder

      • getResponseHeadersToAddList

        public List<HeaderValueOption> 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 interface RateLimitQuotaBucketSettings.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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder

      • getResponseHeadersToAdd

        public HeaderValueOption getResponseHeadersToAdd​(int index)
         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 interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder

      • 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 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,
                                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • getParserForType

        public com.google.protobuf.Parser<RateLimitQuotaBucketSettings.DenyResponseSettings> 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 RateLimitQuotaBucketSettings.DenyResponseSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder