Package io.envoyproxy.envoy.type.v3

Class TokenBucket

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TokenBucketOrBuilder, java.io.Serializable
    public final class TokenBucket
extends com.google.protobuf.GeneratedMessage
implements TokenBucketOrBuilder
     Configures a token bucket, typically used for rate limiting.
    Protobuf type envoy.type.v3.TokenBucket
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TokenBucket.Builder
      Configures a token bucket, typically used for rate limiting.

      • 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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TokenBucket()  
      private TokenBucket​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static TokenBucket getDefaultInstance()  
      TokenBucket getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Duration getFillInterval()
      The fill interval that tokens are added to the bucket.
      com.google.protobuf.DurationOrBuilder getFillIntervalOrBuilder()
      The fill interval that tokens are added to the bucket.
      int getMaxTokens()
      The maximum tokens that the bucket can hold.
      com.google.protobuf.Parser<TokenBucket> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UInt32Value getTokensPerFill()
      The number of tokens added to the bucket during each fill interval.
      com.google.protobuf.UInt32ValueOrBuilder getTokensPerFillOrBuilder()
      The number of tokens added to the bucket during each fill interval.
      boolean hasFillInterval()
      The fill interval that tokens are added to the bucket.
      int hashCode()  
      boolean hasTokensPerFill()
      The number of tokens added to the bucket during each fill interval.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static TokenBucket.Builder newBuilder()  
      static TokenBucket.Builder newBuilder​(TokenBucket prototype)  
      TokenBucket.Builder newBuilderForType()  
      protected TokenBucket.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static TokenBucket parseDelimitedFrom​(java.io.InputStream input)  
      static TokenBucket parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TokenBucket parseFrom​(byte[] data)  
      static TokenBucket parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TokenBucket parseFrom​(com.google.protobuf.ByteString data)  
      static TokenBucket parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TokenBucket parseFrom​(com.google.protobuf.CodedInputStream input)  
      static TokenBucket parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TokenBucket parseFrom​(java.io.InputStream input)  
      static TokenBucket parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TokenBucket parseFrom​(java.nio.ByteBuffer data)  
      static TokenBucket parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<TokenBucket> parser()  
      TokenBucket.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, internalGetMapFieldReflection, 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

      • bitField0_

        private int bitField0_

      • MAX_TOKENS_FIELD_NUMBER

        public static final int MAX_TOKENS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • maxTokens_

        private int maxTokens_

      • TOKENS_PER_FILL_FIELD_NUMBER

        public static final int TOKENS_PER_FILL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • tokensPerFill_

        private com.google.protobuf.UInt32Value tokensPerFill_

      • FILL_INTERVAL_FIELD_NUMBER

        public static final int FILL_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • fillInterval_

        private com.google.protobuf.Duration fillInterval_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final TokenBucket DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<TokenBucket> PARSER

    • Constructor Detail

      • TokenBucket

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

      • TokenBucket

        private TokenBucket()

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • getMaxTokens

        public int getMaxTokens()
         The maximum tokens that the bucket can hold. This is also the number of tokens that the bucket
 initially contains.
        uint32 max_tokens = 1 [(.validate.rules) = { ... }
        Specified by:
        getMaxTokens in interface TokenBucketOrBuilder
        Returns:
        The maxTokens.

      • hasTokensPerFill

        public boolean hasTokensPerFill()
         The number of tokens added to the bucket during each fill interval. If not specified, defaults
 to a single token.
        .google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
        Specified by:
        hasTokensPerFill in interface TokenBucketOrBuilder
        Returns:
        Whether the tokensPerFill field is set.

      • getTokensPerFill

        public com.google.protobuf.UInt32Value getTokensPerFill()
         The number of tokens added to the bucket during each fill interval. If not specified, defaults
 to a single token.
        .google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
        Specified by:
        getTokensPerFill in interface TokenBucketOrBuilder
        Returns:
        The tokensPerFill.

      • getTokensPerFillOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getTokensPerFillOrBuilder()
         The number of tokens added to the bucket during each fill interval. If not specified, defaults
 to a single token.
        .google.protobuf.UInt32Value tokens_per_fill = 2 [(.validate.rules) = { ... }
        Specified by:
        getTokensPerFillOrBuilder in interface TokenBucketOrBuilder

      • hasFillInterval

        public boolean hasFillInterval()
         The fill interval that tokens are added to the bucket. During each fill interval
 ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than
 ``max_tokens`` tokens.
        .google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
        Specified by:
        hasFillInterval in interface TokenBucketOrBuilder
        Returns:
        Whether the fillInterval field is set.

      • getFillInterval

        public com.google.protobuf.Duration getFillInterval()
         The fill interval that tokens are added to the bucket. During each fill interval
 ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than
 ``max_tokens`` tokens.
        .google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
        Specified by:
        getFillInterval in interface TokenBucketOrBuilder
        Returns:
        The fillInterval.

      • getFillIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getFillIntervalOrBuilder()
         The fill interval that tokens are added to the bucket. During each fill interval
 ``tokens_per_fill`` are added to the bucket. The bucket will never contain more than
 ``max_tokens`` tokens.
        .google.protobuf.Duration fill_interval = 3 [(.validate.rules) = { ... }
        Specified by:
        getFillIntervalOrBuilder in interface TokenBucketOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static TokenBucket getDefaultInstance()

      • parser

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

      • getParserForType

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