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

Interface RateLimitQuotaBucketSettings.DenyResponseSettingsOrBuilder

    • Method Detail

      • hasHttpStatus

        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;
        Returns:
        Whether the httpStatus field is set.

      • getHttpStatus

        HttpStatus 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;
        Returns:
        The httpStatus.

      • getHttpStatusOrBuilder

        HttpStatusOrBuilder 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;

      • hasHttpBody

        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;
        Returns:
        Whether the httpBody field is set.

      • getHttpBody

        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;
        Returns:
        The httpBody.

      • getHttpBodyOrBuilder

        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;

      • hasGrpcStatus

        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;
        Returns:
        Whether the grpcStatus field is set.

      • getGrpcStatus

        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;
        Returns:
        The grpcStatus.

      • getGrpcStatusOrBuilder

        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;

      • getResponseHeadersToAddList

        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) = { ... }

      • getResponseHeadersToAdd

        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) = { ... }

      • getResponseHeadersToAddCount

        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) = { ... }

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> 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) = { ... }

      • getResponseHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder​(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) = { ... }