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

Class RateLimitQuotaBucketSettings.BucketIdBuilder.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder, java.lang.Cloneable
    Enclosing class:
    RateLimitQuotaBucketSettings.BucketIdBuilder
    public static final class RateLimitQuotaBucketSettings.BucketIdBuilder.Builder
extends com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaBucketSettings.BucketIdBuilder.Builder>
implements RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder
     ``BucketIdBuilder`` makes it possible to build :ref:`BucketId
 <envoy_v3_api_msg_service.rate_limit_quota.v3.BucketId>` with values substituted
 from the dynamic properties associated with each individual request. See usage examples in
 the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
    Protobuf type envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapFieldReflection

        protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)
        Overrides:
        internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaBucketSettings.BucketIdBuilder.Builder>

      • internalGetMutableMapFieldReflection

        protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection​(int number)
        Overrides:
        internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaBucketSettings.BucketIdBuilder.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RateLimitQuotaBucketSettings.BucketIdBuilder.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.GeneratedMessage.Builder<RateLimitQuotaBucketSettings.BucketIdBuilder.Builder>

      • getDefaultInstanceForType

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public RateLimitQuotaBucketSettings.BucketIdBuilder.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws java.io.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<RateLimitQuotaBucketSettings.BucketIdBuilder.Builder>
        Throws:
        java.io.IOException

      • getBucketIdBuilderCount

        public int getBucketIdBuilderCount()
        Description copied from interface: RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }
        Specified by:
        getBucketIdBuilderCount in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

      • containsBucketIdBuilder

        public boolean containsBucketIdBuilder​(java.lang.String key)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }
        Specified by:
        containsBucketIdBuilder in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

      • getBucketIdBuilderMap

        public java.util.Map<java.lang.String,​RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> getBucketIdBuilderMap()
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }
        Specified by:
        getBucketIdBuilderMap in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

      • getBucketIdBuilderOrDefault

        public RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder getBucketIdBuilderOrDefault​(java.lang.String key,
                                                                                             RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder defaultValue)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }
        Specified by:
        getBucketIdBuilderOrDefault in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

      • getBucketIdBuilderOrThrow

        public RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder getBucketIdBuilderOrThrow​(java.lang.String key)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }
        Specified by:
        getBucketIdBuilderOrThrow in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

      • removeBucketIdBuilder

        public RateLimitQuotaBucketSettings.BucketIdBuilder.Builder removeBucketIdBuilder​(java.lang.String key)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }

      • putBucketIdBuilder

        public RateLimitQuotaBucketSettings.BucketIdBuilder.Builder putBucketIdBuilder​(java.lang.String key,
                                                                               RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder value)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }

      • putAllBucketIdBuilder

        public RateLimitQuotaBucketSettings.BucketIdBuilder.Builder putAllBucketIdBuilder​(java.util.Map<java.lang.String,​RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> values)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }

      • putBucketIdBuilderBuilderIfAbsent

        public RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder.Builder putBucketIdBuilderBuilderIfAbsent​(java.lang.String key)
         The map translated into the ``BucketId`` map.

 The ``string key`` of this map and becomes the key of ``BucketId`` map as is.

 The ``ValueBuilder value`` for the key can be:

 * static ``StringValue string_value`` — becomes the value in the ``BucketId`` map as is.
 * dynamic ``TypedExtensionConfig custom_value`` — evaluated for each request. Must produce
 a string output, which becomes the value in the the ``BucketId`` map.

 See usage examples in the docs to :ref:`bucket_id_builder
 <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.bucket_id_builder>`
 field.
        map<string, .envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> bucket_id_builder = 1 [(.validate.rules) = { ... }