Class RateLimitQuotaBucketSettings.BucketIdBuilder

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.BucketIdBuilder
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder, 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:

  • Field Details

  • Constructor Details

    • BucketIdBuilder

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

    • BucketIdBuilder

      private BucketIdBuilder()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • 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

    • internalGetBucketIdBuilder

      private com.google.protobuf.MapField<String, RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> internalGetBucketIdBuilder()

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

    • getBucketIdBuilder

      @Deprecated public Map<String, RateLimitQuotaBucketSettings.BucketIdBuilder.ValueBuilder> getBucketIdBuilder()
      Deprecated.
      Use getBucketIdBuilderMap() instead.
      Specified by:
      getBucketIdBuilder in interface RateLimitQuotaBucketSettings.BucketIdBuilderOrBuilder

    • getBucketIdBuilderMap

      public Map<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(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(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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom(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) 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RateLimitQuotaBucketSettings.BucketIdBuilder parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static RateLimitQuotaBucketSettings.BucketIdBuilder parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimitQuotaBucketSettings.BucketIdBuilder.Builder newBuilder()

    • newBuilder

      public static RateLimitQuotaBucketSettings.BucketIdBuilder.Builder newBuilder(RateLimitQuotaBucketSettings.BucketIdBuilder prototype)

    • toBuilder

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

    • newBuilderForType

      protected RateLimitQuotaBucketSettings.BucketIdBuilder.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RateLimitQuotaBucketSettings.BucketIdBuilder getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RateLimitQuotaBucketSettings.BucketIdBuilder> parser()

    • 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