Package io.envoyproxy.envoy.type

Class TokenBucket.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TokenBucketOrBuilder, Cloneable
    Enclosing class:
    TokenBucket
    public static final class TokenBucket.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<TokenBucket.Builder>
implements TokenBucketOrBuilder
     Configures a token bucket, typically used for rate limiting.
    Protobuf type envoy.type.TokenBucket

    • Method Detail

      • 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.Builder<TokenBucket.Builder>

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public TokenBucket.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws 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<TokenBucket.Builder>
        Throws:
        IOException

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

      • setMaxTokens

        public TokenBucket.Builder setMaxTokens​(int value)
         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) = { ... }
        Parameters:
        value - The maxTokens to set.
        Returns:
        This builder for chaining.

      • clearMaxTokens

        public TokenBucket.Builder clearMaxTokens()
         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) = { ... }
        Returns:
        This builder for chaining.

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

      • setTokensPerFill

        public TokenBucket.Builder setTokensPerFill​(com.google.protobuf.UInt32Value value)
         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) = { ... }

      • setTokensPerFill

        public TokenBucket.Builder setTokensPerFill​(com.google.protobuf.UInt32Value.Builder builderForValue)
         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) = { ... }

      • mergeTokensPerFill

        public TokenBucket.Builder mergeTokensPerFill​(com.google.protobuf.UInt32Value value)
         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) = { ... }

      • clearTokensPerFill

        public TokenBucket.Builder clearTokensPerFill()
         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) = { ... }

      • getTokensPerFillBuilder

        public com.google.protobuf.UInt32Value.Builder getTokensPerFillBuilder()
         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) = { ... }

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

      • setFillInterval

        public TokenBucket.Builder setFillInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • setFillInterval

        public TokenBucket.Builder setFillInterval​(com.google.protobuf.Duration.Builder builderForValue)
         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) = { ... }

      • mergeFillInterval

        public TokenBucket.Builder mergeFillInterval​(com.google.protobuf.Duration value)
         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) = { ... }

      • clearFillInterval

        public TokenBucket.Builder clearFillInterval()
         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) = { ... }

      • getFillIntervalBuilder

        public com.google.protobuf.Duration.Builder getFillIntervalBuilder()
         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) = { ... }

      • 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

      • setUnknownFields

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

      • mergeUnknownFields

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