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, Serializable
    public final class TokenBucket
extends com.google.protobuf.GeneratedMessageV3
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.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FILL_INTERVAL_FIELD_NUMBER  
      static int MAX_TOKENS_FIELD_NUMBER  
      static int TOKENS_PER_FILL_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

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

        memoizedHashCode

    • Field Detail

      • MAX_TOKENS_FIELD_NUMBER

        public static final int MAX_TOKENS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOKENS_PER_FILL_FIELD_NUMBER

        public static final int TOKENS_PER_FILL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILL_INTERVAL_FIELD_NUMBER

        public static final int FILL_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

      • parseFrom

        public static TokenBucket parseFrom​(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​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

      • getDefaultInstanceForType

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