Package io.envoyproxy.envoy.service.rate_limit_quota.v3

Class BucketId.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BucketId.Builder>
com.google.protobuf.GeneratedMessage.Builder<BucketId.Builder>
io.envoyproxy.envoy.service.rate_limit_quota.v3.BucketId.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BucketIdOrBuilder, Cloneable
Enclosing class:
BucketId
public static final class BucketId.Builder extends com.google.protobuf.GeneratedMessage.Builder<BucketId.Builder> implements BucketIdOrBuilder
 The identifier for the bucket. Used to match the bucket between the control plane (RLQS server),
 and the data plane (RLQS client), f.e.:

 * the data plane sends a usage report for requests matched into the bucket with ``BucketId``
 to the control plane
 * the control plane sends an assignment for the bucket with ``BucketId`` to the data plane
 Bucket ID.

 Example:

 .. validated-code-block:: yaml
 :type-name: envoy.service.rate_limit_quota.v3.BucketId

 bucket:
 name: my_bucket
 env: staging

 .. note::
 The order of ``BucketId`` keys do not matter. Buckets ``{ a: 'A', b: 'B' }`` and
 ``{ b: 'B', a: 'A' }`` are identical.
Protobuf type envoy.service.rate_limit_quota.v3.BucketId

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private com.google.protobuf.MapField<String,String>
    bucket_
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Builder()
     
    private
    Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    BucketId
    build()
     
    BucketId
    buildPartial()
     
    private void
    buildPartial0(BucketId result)
     
    BucketId.Builder
    clear()
     
    BucketId.Builder
    clearBucket()
     
    boolean
    containsBucket(String key)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    Map<String,String>
    getBucket()
    Deprecated.
    int
    getBucketCount()
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    Map<String,String>
    getBucketMap()
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    String
    getBucketOrDefault(String key, String defaultValue)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    String
    getBucketOrThrow(String key)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    BucketId
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    Map<String,String>
    getMutableBucket()
    Deprecated.
    private com.google.protobuf.MapField<String,String>
    internalGetBucket()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    private com.google.protobuf.MapField<String,String>
    internalGetMutableBucket()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMutableMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    BucketId.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    BucketId.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    BucketId.Builder
    mergeFrom(BucketId other)
     
    BucketId.Builder
    putAllBucket(Map<String,String> values)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    BucketId.Builder
    putBucket(String key, String value)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    BucketId.Builder
    removeBucket(String key)
    map<string, string> bucket = 1 [(.validate.rules) = { ...

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • bitField0_

      private int bitField0_

    • bucket_

      private com.google.protobuf.MapField<String,String> bucket_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

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

  • Method Details

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

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<BucketId.Builder>

    • clear

      public BucketId.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.GeneratedMessage.Builder<BucketId.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<BucketId.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • buildPartial0

      private void buildPartial0(BucketId result)

    • mergeFrom

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

    • mergeFrom

      public BucketId.Builder mergeFrom(BucketId other)

    • isInitialized

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

    • mergeFrom

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

    • internalGetBucket

      private com.google.protobuf.MapField<String,String> internalGetBucket()

    • internalGetMutableBucket

      private com.google.protobuf.MapField<String,String> internalGetMutableBucket()

    • getBucketCount

      public int getBucketCount()
      Description copied from interface: BucketIdOrBuilder
      map<string, string> bucket = 1 [(.validate.rules) = { ... }
      Specified by:
      getBucketCount in interface BucketIdOrBuilder

    • containsBucket

      public boolean containsBucket(String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }
      Specified by:
      containsBucket in interface BucketIdOrBuilder

    • getBucket

      @Deprecated public Map<String,String> getBucket()
      Deprecated.
      Use getBucketMap() instead.
      Specified by:
      getBucket in interface BucketIdOrBuilder

    • getBucketMap

      public Map<String,String> getBucketMap()
      map<string, string> bucket = 1 [(.validate.rules) = { ... }
      Specified by:
      getBucketMap in interface BucketIdOrBuilder

    • getBucketOrDefault

      public String getBucketOrDefault(String key, String defaultValue)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }
      Specified by:
      getBucketOrDefault in interface BucketIdOrBuilder

    • getBucketOrThrow

      public String getBucketOrThrow(String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }
      Specified by:
      getBucketOrThrow in interface BucketIdOrBuilder

    • clearBucket

      public BucketId.Builder clearBucket()

    • removeBucket

      public BucketId.Builder removeBucket(String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }

    • getMutableBucket

      @Deprecated public Map<String,String> getMutableBucket()
      Deprecated.
      Use alternate mutation accessors instead.

    • putBucket

      public BucketId.Builder putBucket(String key, String value)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }

    • putAllBucket

      public BucketId.Builder putAllBucket(Map<String,String> values)
      map<string, string> bucket = 1 [(.validate.rules) = { ... }