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

Class RateLimitQuotaBucketSettings.DenyResponseSettings.Builder

    • Method Detail

      • 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.Builder<RateLimitQuotaBucketSettings.DenyResponseSettings.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitQuotaBucketSettings.DenyResponseSettings.Builder>

      • getDefaultInstanceForType

        public RateLimitQuotaBucketSettings.DenyResponseSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • buildPartial

        public RateLimitQuotaBucketSettings.DenyResponseSettings buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • 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.

      • setHttpStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setHttpStatus​(HttpStatus value)
         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;

      • mergeHttpStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder mergeHttpStatus​(HttpStatus value)
         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;

      • clearHttpStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder clearHttpStatus()
         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;

      • getHttpStatusBuilder

        public HttpStatus.Builder getHttpStatusBuilder()
         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;

      • setHttpBody

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setHttpBody​(com.google.protobuf.BytesValue.Builder builderForValue)
         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;

      • mergeHttpBody

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder mergeHttpBody​(com.google.protobuf.BytesValue value)
         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;

      • getHttpBodyBuilder

        public com.google.protobuf.BytesValue.Builder getHttpBodyBuilder()
         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

        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.

      • setGrpcStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setGrpcStatus​(Status value)
         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;

      • setGrpcStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setGrpcStatus​(Status.Builder builderForValue)
         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;

      • mergeGrpcStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder mergeGrpcStatus​(Status value)
         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;

      • clearGrpcStatus

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder clearGrpcStatus()
         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;

      • getGrpcStatusBuilder

        public Status.Builder getGrpcStatusBuilder()
         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;

      • 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

      • setResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setResponseHeadersToAdd​(int index,
                                                                                         HeaderValueOption value)
         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) = { ... }

      • setResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder setResponseHeadersToAdd​(int index,
                                                                                         HeaderValueOption.Builder builderForValue)
         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) = { ... }

      • addResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder addResponseHeadersToAdd​(HeaderValueOption value)
         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) = { ... }

      • addResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder addResponseHeadersToAdd​(int index,
                                                                                         HeaderValueOption value)
         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) = { ... }

      • addResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder addResponseHeadersToAdd​(HeaderValueOption.Builder builderForValue)
         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) = { ... }

      • addResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder addResponseHeadersToAdd​(int index,
                                                                                         HeaderValueOption.Builder builderForValue)
         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) = { ... }

      • addAllResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder addAllResponseHeadersToAdd​(Iterable<? extends HeaderValueOption> values)
         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) = { ... }

      • clearResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder clearResponseHeadersToAdd()
         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) = { ... }

      • removeResponseHeadersToAdd

        public RateLimitQuotaBucketSettings.DenyResponseSettings.Builder removeResponseHeadersToAdd​(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) = { ... }

      • getResponseHeadersToAddBuilder

        public HeaderValueOption.Builder getResponseHeadersToAddBuilder​(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) = { ... }

      • addResponseHeadersToAddBuilder

        public HeaderValueOption.Builder addResponseHeadersToAddBuilder()
         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) = { ... }

      • addResponseHeadersToAddBuilder

        public HeaderValueOption.Builder addResponseHeadersToAddBuilder​(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) = { ... }

      • getResponseHeadersToAddBuilderList

        public List<HeaderValueOption.Builder> getResponseHeadersToAddBuilderList()
         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) = { ... }