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

Class BucketId

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.service.rate_limit_quota.v3.BucketId
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BucketIdOrBuilder, Serializable
@Generated 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    private static final class 
    BucketId.BucketDefaultEntryHolder
     
    static final 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>, 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<String,String>
    bucket_
     
    static final int
    BUCKET_FIELD_NUMBER
     
    private static final BucketId
    DEFAULT_INSTANCE
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<BucketId>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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

    Modifier and Type
    Method
    Description
    boolean
    containsBucket(String key)
    map<string, string> bucket = 1 [(.validate.rules) = { ...
    boolean
    equals(Object obj)
     
    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) = { ...
    static BucketId
    getDefaultInstance()
     
    BucketId
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Parser<BucketId>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    private com.google.protobuf.MapField<String,String>
    internalGetBucket()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final 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(InputStream input)
     
    static BucketId
    parseDelimitedFrom(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(InputStream input)
     
    static BucketId
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BucketId
    parseFrom(ByteBuffer data)
     
    static BucketId
    parseFrom(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

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • BUCKET_FIELD_NUMBER

      public static final int BUCKET_FIELD_NUMBER
      See Also:

    • bucket_

      private com.google.protobuf.MapField<String,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 Details

    • BucketId

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

    • BucketId

      private BucketId()

  • 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

    • internalGetBucket

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

    • 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

    • 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 BucketId parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

      public static BucketId parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BucketId.Builder newBuilder()

    • newBuilder

      public static BucketId.Builder newBuilder(BucketId prototype)

    • 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