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

Class RateLimitQuotaBucketSettings.BucketIdBuilder

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder, java.io.Serializable
    Enclosing class:
    RateLimitQuotaBucketSettings
    public static final class RateLimitQuotaBucketSettings.BucketIdBuilder
extends com.google.protobuf.GeneratedMessage
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
    See Also:
    Serialized Form

    • Constructor Detail

      • BucketIdBuilder

        private BucketIdBuilder​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • BucketIdBuilder

        private BucketIdBuilder()

    • 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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • 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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(java.nio.ByteBuffer data)
                                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(java.nio.ByteBuffer data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(com.google.protobuf.ByteString data)
                                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(com.google.protobuf.ByteString data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(byte[] data,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(java.io.InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseDelimitedFrom​(java.io.InputStream input,
                                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • getParserForType

        public com.google.protobuf.Parser<RateLimitQuotaBucketSettings.BucketIdBuilder> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

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