Package io.envoyproxy.envoy.service.ratelimit.v3

Class RateLimitResponse.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitResponseOrBuilder, Cloneable
    Enclosing class:
    RateLimitResponse
    public static final class RateLimitResponse.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitResponse.Builder>
implements RateLimitResponseOrBuilder
     A response from a ShouldRateLimit call.
 [#next-free-field: 8]
    Protobuf type envoy.service.ratelimit.v3.RateLimitResponse

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

      • clear

        public RateLimitResponse.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<RateLimitResponse.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<RateLimitResponse.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • setField

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • clearField

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • clearOneof

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • setRepeatedField

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • addRepeatedField

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • mergeFrom

        public RateLimitResponse.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<RateLimitResponse.Builder>

      • isInitialized

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

      • mergeFrom

        public RateLimitResponse.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<RateLimitResponse.Builder>
        Throws:
        IOException

      • getOverallCodeValue

        public 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;
        Specified by:
        getOverallCodeValue in interface RateLimitResponseOrBuilder
        Returns:
        The enum numeric value on the wire for overallCode.

      • setOverallCodeValue

        public RateLimitResponse.Builder setOverallCodeValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for overallCode to set.
        Returns:
        This builder for chaining.

      • getOverallCode

        public 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;
        Specified by:
        getOverallCode in interface RateLimitResponseOrBuilder
        Returns:
        The overallCode.

      • setOverallCode

        public RateLimitResponse.Builder setOverallCode​(RateLimitResponse.Code value)
         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;
        Parameters:
        value - The overallCode to set.
        Returns:
        This builder for chaining.

      • clearOverallCode

        public RateLimitResponse.Builder clearOverallCode()
         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;
        Returns:
        This builder for chaining.

      • getStatusesList

        public 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;
        Specified by:
        getStatusesList in interface RateLimitResponseOrBuilder

      • getStatusesCount

        public 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;
        Specified by:
        getStatusesCount in interface RateLimitResponseOrBuilder

      • getStatuses

        public 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;
        Specified by:
        getStatuses in interface RateLimitResponseOrBuilder

      • setStatuses

        public RateLimitResponse.Builder setStatuses​(int index,
                                             RateLimitResponse.DescriptorStatus value)
         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;

      • setStatuses

        public RateLimitResponse.Builder setStatuses​(int index,
                                             RateLimitResponse.DescriptorStatus.Builder builderForValue)
         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;

      • addStatuses

        public RateLimitResponse.Builder addStatuses​(RateLimitResponse.DescriptorStatus value)
         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;

      • addStatuses

        public RateLimitResponse.Builder addStatuses​(int index,
                                             RateLimitResponse.DescriptorStatus value)
         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;

      • addStatuses

        public RateLimitResponse.Builder addStatuses​(RateLimitResponse.DescriptorStatus.Builder builderForValue)
         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;

      • addStatuses

        public RateLimitResponse.Builder addStatuses​(int index,
                                             RateLimitResponse.DescriptorStatus.Builder builderForValue)
         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;

      • addAllStatuses

        public RateLimitResponse.Builder addAllStatuses​(Iterable<? extends RateLimitResponse.DescriptorStatus> values)
         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;

      • clearStatuses

        public RateLimitResponse.Builder clearStatuses()
         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;

      • removeStatuses

        public RateLimitResponse.Builder removeStatuses​(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;

      • getStatusesBuilder

        public RateLimitResponse.DescriptorStatus.Builder getStatusesBuilder​(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

        public 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;
        Specified by:
        getStatusesOrBuilder in interface RateLimitResponseOrBuilder

      • getStatusesOrBuilderList

        public 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;
        Specified by:
        getStatusesOrBuilderList in interface RateLimitResponseOrBuilder

      • addStatusesBuilder

        public RateLimitResponse.DescriptorStatus.Builder addStatusesBuilder()
         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;

      • addStatusesBuilder

        public RateLimitResponse.DescriptorStatus.Builder addStatusesBuilder​(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;

      • getStatusesBuilderList

        public List<RateLimitResponse.DescriptorStatus.Builder> getStatusesBuilderList()
         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;

      • getResponseHeadersToAddCount

        public int getResponseHeadersToAddCount()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;
        Specified by:
        getResponseHeadersToAddCount in interface RateLimitResponseOrBuilder

      • setResponseHeadersToAdd

        public RateLimitResponse.Builder setResponseHeadersToAdd​(int index,
                                                         HeaderValue value)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • setResponseHeadersToAdd

        public RateLimitResponse.Builder setResponseHeadersToAdd​(int index,
                                                         HeaderValue.Builder builderForValue)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAdd

        public RateLimitResponse.Builder addResponseHeadersToAdd​(HeaderValue value)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAdd

        public RateLimitResponse.Builder addResponseHeadersToAdd​(int index,
                                                         HeaderValue value)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAdd

        public RateLimitResponse.Builder addResponseHeadersToAdd​(HeaderValue.Builder builderForValue)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAdd

        public RateLimitResponse.Builder addResponseHeadersToAdd​(int index,
                                                         HeaderValue.Builder builderForValue)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addAllResponseHeadersToAdd

        public RateLimitResponse.Builder addAllResponseHeadersToAdd​(Iterable<? extends HeaderValue> values)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • clearResponseHeadersToAdd

        public RateLimitResponse.Builder clearResponseHeadersToAdd()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • removeResponseHeadersToAdd

        public RateLimitResponse.Builder removeResponseHeadersToAdd​(int index)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAddBuilder

        public HeaderValue.Builder getResponseHeadersToAddBuilder​(int index)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAddBuilder

        public HeaderValue.Builder addResponseHeadersToAddBuilder()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • addResponseHeadersToAddBuilder

        public HeaderValue.Builder addResponseHeadersToAddBuilder​(int index)
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getResponseHeadersToAddBuilderList

        public List<HeaderValue.Builder> getResponseHeadersToAddBuilderList()
         A list of headers to add to the response
        repeated .envoy.config.core.v3.HeaderValue response_headers_to_add = 3;

      • getRequestHeadersToAddCount

        public int getRequestHeadersToAddCount()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;
        Specified by:
        getRequestHeadersToAddCount in interface RateLimitResponseOrBuilder

      • setRequestHeadersToAdd

        public RateLimitResponse.Builder setRequestHeadersToAdd​(int index,
                                                        HeaderValue value)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • setRequestHeadersToAdd

        public RateLimitResponse.Builder setRequestHeadersToAdd​(int index,
                                                        HeaderValue.Builder builderForValue)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAdd

        public RateLimitResponse.Builder addRequestHeadersToAdd​(HeaderValue value)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAdd

        public RateLimitResponse.Builder addRequestHeadersToAdd​(int index,
                                                        HeaderValue value)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAdd

        public RateLimitResponse.Builder addRequestHeadersToAdd​(HeaderValue.Builder builderForValue)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAdd

        public RateLimitResponse.Builder addRequestHeadersToAdd​(int index,
                                                        HeaderValue.Builder builderForValue)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addAllRequestHeadersToAdd

        public RateLimitResponse.Builder addAllRequestHeadersToAdd​(Iterable<? extends HeaderValue> values)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • clearRequestHeadersToAdd

        public RateLimitResponse.Builder clearRequestHeadersToAdd()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • removeRequestHeadersToAdd

        public RateLimitResponse.Builder removeRequestHeadersToAdd​(int index)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAddBuilder

        public HeaderValue.Builder getRequestHeadersToAddBuilder​(int index)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAddBuilder

        public HeaderValue.Builder addRequestHeadersToAddBuilder()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • addRequestHeadersToAddBuilder

        public HeaderValue.Builder addRequestHeadersToAddBuilder​(int index)
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRequestHeadersToAddBuilderList

        public List<HeaderValue.Builder> getRequestHeadersToAddBuilderList()
         A list of headers to add to the request when forwarded
        repeated .envoy.config.core.v3.HeaderValue request_headers_to_add = 4;

      • getRawBody

        public 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;
        Specified by:
        getRawBody in interface RateLimitResponseOrBuilder
        Returns:
        The rawBody.

      • setRawBody

        public RateLimitResponse.Builder setRawBody​(com.google.protobuf.ByteString value)
         A response body to send to the downstream client when the response code is not OK.
        bytes raw_body = 5;
        Parameters:
        value - The rawBody to set.
        Returns:
        This builder for chaining.

      • clearRawBody

        public RateLimitResponse.Builder clearRawBody()
         A response body to send to the downstream client when the response code is not OK.
        bytes raw_body = 5;
        Returns:
        This builder for chaining.

      • hasDynamicMetadata

        public 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;
        Specified by:
        hasDynamicMetadata in interface RateLimitResponseOrBuilder
        Returns:
        Whether the dynamicMetadata field is set.

      • getDynamicMetadata

        public 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;
        Specified by:
        getDynamicMetadata in interface RateLimitResponseOrBuilder
        Returns:
        The dynamicMetadata.

      • setDynamicMetadata

        public RateLimitResponse.Builder setDynamicMetadata​(com.google.protobuf.Struct value)
         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;

      • setDynamicMetadata

        public RateLimitResponse.Builder setDynamicMetadata​(com.google.protobuf.Struct.Builder builderForValue)
         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;

      • mergeDynamicMetadata

        public RateLimitResponse.Builder mergeDynamicMetadata​(com.google.protobuf.Struct value)
         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;

      • clearDynamicMetadata

        public RateLimitResponse.Builder clearDynamicMetadata()
         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;

      • getDynamicMetadataBuilder

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

        public 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;
        Specified by:
        getDynamicMetadataOrBuilder in interface RateLimitResponseOrBuilder

      • hasQuota

        public boolean hasQuota()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;
        Specified by:
        hasQuota in interface RateLimitResponseOrBuilder
        Returns:
        Whether the quota field is set.

      • getQuota

        public RateLimitResponse.Quota getQuota()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;
        Specified by:
        getQuota in interface RateLimitResponseOrBuilder
        Returns:
        The quota.

      • setQuota

        public RateLimitResponse.Builder setQuota​(RateLimitResponse.Quota value)
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;

      • setQuota

        public RateLimitResponse.Builder setQuota​(RateLimitResponse.Quota.Builder builderForValue)
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;

      • mergeQuota

        public RateLimitResponse.Builder mergeQuota​(RateLimitResponse.Quota value)
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;

      • clearQuota

        public RateLimitResponse.Builder clearQuota()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;

      • getQuotaBuilder

        public RateLimitResponse.Quota.Builder getQuotaBuilder()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;

      • getQuotaOrBuilder

        public RateLimitResponse.QuotaOrBuilder getQuotaOrBuilder()
         Quota is available for a request if its entire descriptor set has cached quota available.
 This is a union of all descriptors in the descriptor set. Clients can use the quota for future matches if and only if the descriptor set matches what was sent in the request that originated this response.
 If quota is available, a RLS request will not be made and the quota will be reduced by 1.
 If quota is not available (i.e., a cached entry doesn't exist for a RLS descriptor set), a RLS request will be triggered.
 If the server did not provide a quota, such as the quota message is empty then the request admission is determined by the
 :ref:`overall_code <envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.overall_code>`.
 If there is not sufficient quota and the cached entry exists for a RLS descriptor set is out-of-quota but not expired,
 the request will be treated as OVER_LIMIT.
 [#not-implemented-hide:]
        .envoy.service.ratelimit.v3.RateLimitResponse.Quota quota = 7;
        Specified by:
        getQuotaOrBuilder in interface RateLimitResponseOrBuilder

      • setUnknownFields

        public final RateLimitResponse.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<RateLimitResponse.Builder>

      • mergeUnknownFields

        public final RateLimitResponse.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<RateLimitResponse.Builder>