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

Class BucketId.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BucketIdOrBuilder, java.lang.Cloneable
    Enclosing class:
    BucketId
    public static final class BucketId.Builder
extends com.google.protobuf.GeneratedMessageV3.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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      BucketId.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      BucketId build()  
      BucketId buildPartial()  
      BucketId.Builder clear()  
      BucketId.Builder clearBucket()  
      BucketId.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      BucketId.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      BucketId.Builder clone()  
      boolean containsBucket​(java.lang.String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      java.util.Map<java.lang.String,​java.lang.String> getBucket()
      Deprecated.
      int getBucketCount()
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      java.util.Map<java.lang.String,​java.lang.String> getBucketMap()
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      java.lang.String getBucketOrDefault​(java.lang.String key, java.lang.String defaultValue)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      java.lang.String getBucketOrThrow​(java.lang.String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      BucketId getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.util.Map<java.lang.String,​java.lang.String> getMutableBucket()
      Deprecated.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      protected com.google.protobuf.MapField internalGetMutableMapField​(int number)  
      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 mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      BucketId.Builder putAllBucket​(java.util.Map<java.lang.String,​java.lang.String> values)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      BucketId.Builder putBucket​(java.lang.String key, java.lang.String value)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      BucketId.Builder removeBucket​(java.lang.String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      BucketId.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      BucketId.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      BucketId.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

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

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

        addAll, addAll, 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.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BucketId.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BucketId.Builder>

      • internalGetFieldAccessorTable

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

      • clone

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

      • setField

        public BucketId.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<BucketId.Builder>

      • clearField

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

      • clearOneof

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

      • setRepeatedField

        public BucketId.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BucketId.Builder>

      • addRepeatedField

        public BucketId.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BucketId.Builder>

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

      • isInitialized

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

      • mergeFrom

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

      • containsBucket

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

      • getBucketMap

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

      • getBucketOrDefault

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

      • getBucketOrThrow

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

      • removeBucket

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

      • getMutableBucket

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

      • putBucket

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

      • putAllBucket

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

      • setUnknownFields

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

      • mergeUnknownFields

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