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

Class RateLimit.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitOrBuilder, Cloneable
    Enclosing class:
    RateLimit
    public static final class RateLimit.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>
implements RateLimitOrBuilder
     [#next-free-field: 11]
    Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimit

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

      • clear

        public RateLimit.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.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<RateLimit.Builder>

      • getDefaultInstanceForType

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

      • build

        public RateLimit build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

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

      • clone

        public RateLimit.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • setField

        public RateLimit.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • clearField

        public RateLimit.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • clearOneof

        public RateLimit.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • setRepeatedField

        public RateLimit.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • addRepeatedField

        public RateLimit.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • mergeFrom

        public RateLimit.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • mergeFrom

        public RateLimit.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Builder>
        Throws:
        IOException

      • getDomain

        public String getDomain()
         The rate limit domain to use when calling the rate limit service.
        string domain = 1 [(.validate.rules) = { ... }
        Specified by:
        getDomain in interface RateLimitOrBuilder

      • getDomainBytes

        public com.google.protobuf.ByteString getDomainBytes()
         The rate limit domain to use when calling the rate limit service.
        string domain = 1 [(.validate.rules) = { ... }
        Specified by:
        getDomainBytes in interface RateLimitOrBuilder

      • setDomain

        public RateLimit.Builder setDomain​(String value)
         The rate limit domain to use when calling the rate limit service.
        string domain = 1 [(.validate.rules) = { ... }

      • clearDomain

        public RateLimit.Builder clearDomain()
         The rate limit domain to use when calling the rate limit service.
        string domain = 1 [(.validate.rules) = { ... }

      • setDomainBytes

        public RateLimit.Builder setDomainBytes​(com.google.protobuf.ByteString value)
         The rate limit domain to use when calling the rate limit service.
        string domain = 1 [(.validate.rules) = { ... }

      • getStage

        public int getStage()
         Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
        uint32 stage = 2 [(.validate.rules) = { ... }
        Specified by:
        getStage in interface RateLimitOrBuilder

      • setStage

        public RateLimit.Builder setStage​(int value)
         Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
        uint32 stage = 2 [(.validate.rules) = { ... }

      • clearStage

        public RateLimit.Builder clearStage()
         Specifies the rate limit configurations to be applied with the same
 stage number. If not set, the default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
        uint32 stage = 2 [(.validate.rules) = { ... }

      • getRequestType

        public String getRequestType()
         The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
        string request_type = 3 [(.validate.rules) = { ... }
        Specified by:
        getRequestType in interface RateLimitOrBuilder

      • getRequestTypeBytes

        public com.google.protobuf.ByteString getRequestTypeBytes()
         The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
        string request_type = 3 [(.validate.rules) = { ... }
        Specified by:
        getRequestTypeBytes in interface RateLimitOrBuilder

      • setRequestType

        public RateLimit.Builder setRequestType​(String value)
         The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
        string request_type = 3 [(.validate.rules) = { ... }

      • clearRequestType

        public RateLimit.Builder clearRequestType()
         The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
        string request_type = 3 [(.validate.rules) = { ... }

      • setRequestTypeBytes

        public RateLimit.Builder setRequestTypeBytes​(com.google.protobuf.ByteString value)
         The type of requests the filter should apply to. The supported
 types are *internal*, *external* or *both*. A request is considered internal if
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If
 :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a
 request is considered external. The filter defaults to *both*, and it will apply to all request
 types.
        string request_type = 3 [(.validate.rules) = { ... }

      • hasTimeout

        public boolean hasTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        hasTimeout in interface RateLimitOrBuilder

      • getTimeout

        public com.google.protobuf.Duration getTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        getTimeout in interface RateLimitOrBuilder

      • setTimeout

        public RateLimit.Builder setTimeout​(com.google.protobuf.Duration value)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • setTimeout

        public RateLimit.Builder setTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • mergeTimeout

        public RateLimit.Builder mergeTimeout​(com.google.protobuf.Duration value)
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • clearTimeout

        public RateLimit.Builder clearTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • getTimeoutBuilder

        public com.google.protobuf.Duration.Builder getTimeoutBuilder()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;

      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 4;
        Specified by:
        getTimeoutOrBuilder in interface RateLimitOrBuilder

      • getFailureModeDeny

        public boolean getFailureModeDeny()
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
        bool failure_mode_deny = 5;
        Specified by:
        getFailureModeDeny in interface RateLimitOrBuilder

      • setFailureModeDeny

        public RateLimit.Builder setFailureModeDeny​(boolean value)
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
        bool failure_mode_deny = 5;

      • clearFailureModeDeny

        public RateLimit.Builder clearFailureModeDeny()
         The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
        bool failure_mode_deny = 5;

      • getRateLimitedAsResourceExhausted

        public boolean getRateLimitedAsResourceExhausted()
         Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
 of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call. The
 HTTP code will be 200 for a gRPC response.
        bool rate_limited_as_resource_exhausted = 6;
        Specified by:
        getRateLimitedAsResourceExhausted in interface RateLimitOrBuilder

      • setRateLimitedAsResourceExhausted

        public RateLimit.Builder setRateLimitedAsResourceExhausted​(boolean value)
         Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
 of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call. The
 HTTP code will be 200 for a gRPC response.
        bool rate_limited_as_resource_exhausted = 6;

      • clearRateLimitedAsResourceExhausted

        public RateLimit.Builder clearRateLimitedAsResourceExhausted()
         Specifies whether a `RESOURCE_EXHAUSTED` gRPC code must be returned instead
 of the default `UNAVAILABLE` gRPC code for a rate limited gRPC call. The
 HTTP code will be 200 for a gRPC response.
        bool rate_limited_as_resource_exhausted = 6;

      • hasRateLimitService

        public boolean hasRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }
        Specified by:
        hasRateLimitService in interface RateLimitOrBuilder

      • getRateLimitService

        public RateLimitServiceConfig getRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }
        Specified by:
        getRateLimitService in interface RateLimitOrBuilder

      • setRateLimitService

        public RateLimit.Builder setRateLimitService​(RateLimitServiceConfig value)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

      • setRateLimitService

        public RateLimit.Builder setRateLimitService​(RateLimitServiceConfig.Builder builderForValue)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

      • mergeRateLimitService

        public RateLimit.Builder mergeRateLimitService​(RateLimitServiceConfig value)
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

      • clearRateLimitService

        public RateLimit.Builder clearRateLimitService()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

      • getRateLimitServiceBuilder

        public RateLimitServiceConfig.Builder getRateLimitServiceBuilder()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }

      • getRateLimitServiceOrBuilder

        public RateLimitServiceConfigOrBuilder getRateLimitServiceOrBuilder()
         Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
        .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 7 [(.validate.rules) = { ... }
        Specified by:
        getRateLimitServiceOrBuilder in interface RateLimitOrBuilder

      • getEnableXRatelimitHeadersValue

        public int getEnableXRatelimitHeadersValue()
         Defines the standard version to use for X-RateLimit headers emitted by the filter:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The values are returned by the rate limiting service in
   :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>`
   field. Example: `10, 10;w=1;name="per-ip", 1000;w=3600`.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The values are returned by the rate limiting service
   in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>`
   field.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The values are returned by the rate limiting service
   in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>`
   field.
 In case rate limiting policy specifies more then one time window, the values
 above represent the window that is closest to reaching its limit.
 For more information about the headers specification see selected version of
 the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_.
 Disabled by default.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
        .envoy.extensions.filters.http.ratelimit.v3.RateLimit.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 8 [(.validate.rules) = { ... }
        Specified by:
        getEnableXRatelimitHeadersValue in interface RateLimitOrBuilder

      • setEnableXRatelimitHeadersValue

        public RateLimit.Builder setEnableXRatelimitHeadersValue​(int value)
         Defines the standard version to use for X-RateLimit headers emitted by the filter:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The values are returned by the rate limiting service in
   :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>`
   field. Example: `10, 10;w=1;name="per-ip", 1000;w=3600`.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The values are returned by the rate limiting service
   in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>`
   field.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The values are returned by the rate limiting service
   in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>`
   field.
 In case rate limiting policy specifies more then one time window, the values
 above represent the window that is closest to reaching its limit.
 For more information about the headers specification see selected version of
 the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_.
 Disabled by default.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
        .envoy.extensions.filters.http.ratelimit.v3.RateLimit.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 8 [(.validate.rules) = { ... }

      • getEnableXRatelimitHeaders

        public RateLimit.XRateLimitHeadersRFCVersion getEnableXRatelimitHeaders()
         Defines the standard version to use for X-RateLimit headers emitted by the filter:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The values are returned by the rate limiting service in
   :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>`
   field. Example: `10, 10;w=1;name="per-ip", 1000;w=3600`.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The values are returned by the rate limiting service
   in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>`
   field.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The values are returned by the rate limiting service
   in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>`
   field.
 In case rate limiting policy specifies more then one time window, the values
 above represent the window that is closest to reaching its limit.
 For more information about the headers specification see selected version of
 the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_.
 Disabled by default.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
        .envoy.extensions.filters.http.ratelimit.v3.RateLimit.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 8 [(.validate.rules) = { ... }
        Specified by:
        getEnableXRatelimitHeaders in interface RateLimitOrBuilder

      • setEnableXRatelimitHeaders

        public RateLimit.Builder setEnableXRatelimitHeaders​(RateLimit.XRateLimitHeadersRFCVersion value)
         Defines the standard version to use for X-RateLimit headers emitted by the filter:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The values are returned by the rate limiting service in
   :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>`
   field. Example: `10, 10;w=1;name="per-ip", 1000;w=3600`.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The values are returned by the rate limiting service
   in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>`
   field.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The values are returned by the rate limiting service
   in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>`
   field.
 In case rate limiting policy specifies more then one time window, the values
 above represent the window that is closest to reaching its limit.
 For more information about the headers specification see selected version of
 the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_.
 Disabled by default.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
        .envoy.extensions.filters.http.ratelimit.v3.RateLimit.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 8 [(.validate.rules) = { ... }

      • clearEnableXRatelimitHeaders

        public RateLimit.Builder clearEnableXRatelimitHeaders()
         Defines the standard version to use for X-RateLimit headers emitted by the filter:
 * ``X-RateLimit-Limit`` - indicates the request-quota associated to the
   client in the current time-window followed by the description of the
   quota policy. The values are returned by the rate limiting service in
   :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>`
   field. Example: `10, 10;w=1;name="per-ip", 1000;w=3600`.
 * ``X-RateLimit-Remaining`` - indicates the remaining requests in the
   current time-window. The values are returned by the rate limiting service
   in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>`
   field.
 * ``X-RateLimit-Reset`` - indicates the number of seconds until reset of
   the current time-window. The values are returned by the rate limiting service
   in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>`
   field.
 In case rate limiting policy specifies more then one time window, the values
 above represent the window that is closest to reaching its limit.
 For more information about the headers specification see selected version of
 the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_.
 Disabled by default.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
        .envoy.extensions.filters.http.ratelimit.v3.RateLimit.XRateLimitHeadersRFCVersion enable_x_ratelimit_headers = 8 [(.validate.rules) = { ... }

      • getDisableXEnvoyRatelimitedHeader

        public boolean getDisableXEnvoyRatelimitedHeader()
         Disables emitting the :ref:`x-envoy-ratelimited<config_http_filters_router_x-envoy-ratelimited>` header
 in case of rate limiting (i.e. 429 responses).
 Having this header not present potentially makes the request retriable.
        bool disable_x_envoy_ratelimited_header = 9;
        Specified by:
        getDisableXEnvoyRatelimitedHeader in interface RateLimitOrBuilder

      • setDisableXEnvoyRatelimitedHeader

        public RateLimit.Builder setDisableXEnvoyRatelimitedHeader​(boolean value)
         Disables emitting the :ref:`x-envoy-ratelimited<config_http_filters_router_x-envoy-ratelimited>` header
 in case of rate limiting (i.e. 429 responses).
 Having this header not present potentially makes the request retriable.
        bool disable_x_envoy_ratelimited_header = 9;

      • clearDisableXEnvoyRatelimitedHeader

        public RateLimit.Builder clearDisableXEnvoyRatelimitedHeader()
         Disables emitting the :ref:`x-envoy-ratelimited<config_http_filters_router_x-envoy-ratelimited>` header
 in case of rate limiting (i.e. 429 responses).
 Having this header not present potentially makes the request retriable.
        bool disable_x_envoy_ratelimited_header = 9;

      • hasRateLimitedStatus

        public boolean hasRateLimitedStatus()
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;
        Specified by:
        hasRateLimitedStatus in interface RateLimitOrBuilder

      • getRateLimitedStatus

        public HttpStatus getRateLimitedStatus()
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;
        Specified by:
        getRateLimitedStatus in interface RateLimitOrBuilder

      • setRateLimitedStatus

        public RateLimit.Builder setRateLimitedStatus​(HttpStatus value)
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;

      • setRateLimitedStatus

        public RateLimit.Builder setRateLimitedStatus​(HttpStatus.Builder builderForValue)
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;

      • mergeRateLimitedStatus

        public RateLimit.Builder mergeRateLimitedStatus​(HttpStatus value)
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;

      • clearRateLimitedStatus

        public RateLimit.Builder clearRateLimitedStatus()
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;

      • getRateLimitedStatusBuilder

        public HttpStatus.Builder getRateLimitedStatusBuilder()
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;

      • getRateLimitedStatusOrBuilder

        public HttpStatusOrBuilder getRateLimitedStatusOrBuilder()
         This field allows for a custom HTTP response status code to the downstream client when
 the request has been rate limited.
 Defaults to 429 (TooManyRequests).
 .. note::
   If this is set to < 400, 429 will be used instead.
        .envoy.type.v3.HttpStatus rate_limited_status = 10;
        Specified by:
        getRateLimitedStatusOrBuilder in interface RateLimitOrBuilder

      • setUnknownFields

        public final RateLimit.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>

      • mergeUnknownFields

        public final RateLimit.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Builder>