Class BucketId

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BucketIdOrBuilder, java.io.Serializable

    public final class BucketId
    extends com.google.protobuf.GeneratedMessage
    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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  BucketId.BucketDefaultEntryHolder  
      static class  BucketId.Builder
      The identifier for the bucket.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private com.google.protobuf.MapField<java.lang.String,​java.lang.String> bucket_  
      static int BUCKET_FIELD_NUMBER  
      private static BucketId DEFAULT_INSTANCE  
      private byte memoizedIsInitialized  
      private static com.google.protobuf.Parser<BucketId> PARSER  
      private static long serialVersionUID  
      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private BucketId()  
      private BucketId​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsBucket​(java.lang.String key)
      map<string, string> bucket = 1 [(.validate.rules) = { ...
      boolean equals​(java.lang.Object obj)  
      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) = { ...
      static BucketId getDefaultInstance()  
      BucketId getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<BucketId> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      private com.google.protobuf.MapField<java.lang.String,​java.lang.String> internalGetBucket()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)  
      boolean isInitialized()  
      static BucketId.Builder newBuilder()  
      static BucketId.Builder newBuilder​(BucketId prototype)  
      BucketId.Builder newBuilderForType()  
      protected BucketId.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static BucketId parseDelimitedFrom​(java.io.InputStream input)  
      static BucketId parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static BucketId parseFrom​(byte[] data)  
      static BucketId parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static BucketId parseFrom​(com.google.protobuf.ByteString data)  
      static BucketId parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static BucketId parseFrom​(com.google.protobuf.CodedInputStream input)  
      static BucketId parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static BucketId parseFrom​(java.io.InputStream input)  
      static BucketId parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static BucketId parseFrom​(java.nio.ByteBuffer data)  
      static BucketId parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<BucketId> parser()  
      BucketId.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • bucket_

        private com.google.protobuf.MapField<java.lang.String,​java.lang.String> bucket_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final BucketId DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<BucketId> PARSER
    • Constructor Detail

      • BucketId

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

        private BucketId()
    • 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
      • internalGetBucket

        private com.google.protobuf.MapField<java.lang.String,​java.lang.String> internalGetBucket()
      • 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
      • 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 BucketId parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static BucketId parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static BucketId parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static BucketId parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

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

        public static BucketId parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

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

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

        protected BucketId.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static BucketId getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<BucketId> parser()
      • getParserForType

        public com.google.protobuf.Parser<BucketId> 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 BucketId getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder