Class TokenBucket.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<TokenBucket.Builder>
com.google.protobuf.GeneratedMessage.Builder<TokenBucket.Builder>
io.envoyproxy.envoy.type.v3.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.GeneratedMessage.Builder<TokenBucket.Builder> implements TokenBucketOrBuilder
Configures a token bucket, typically used for rate limiting.
Protobuf type envoy.type.v3.TokenBucket

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private com.google.protobuf.Duration
    fillInterval_
     
    private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder>
    fillIntervalBuilder_
     
    private int
    maxTokens_
     
    private com.google.protobuf.UInt32Value
    tokensPerFill_
     
    private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder>
    tokensPerFillBuilder_
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Builder()
     
    private
    Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    TokenBucket
    build()
     
    TokenBucket
    buildPartial()
     
    private void
    buildPartial0(TokenBucket result)
     
    TokenBucket.Builder
    clear()
     
    TokenBucket.Builder
    clearFillInterval()
    The fill interval that tokens are added to the bucket.
    TokenBucket.Builder
    clearMaxTokens()
    The maximum tokens that the bucket can hold.
    TokenBucket.Builder
    clearTokensPerFill()
    The number of tokens added to the bucket during each fill interval.
    TokenBucket
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Duration
    getFillInterval()
    The fill interval that tokens are added to the bucket.
    com.google.protobuf.Duration.Builder
    getFillIntervalBuilder()
    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.UInt32Value
    getTokensPerFill()
    The number of tokens added to the bucket during each fill interval.
    com.google.protobuf.UInt32Value.Builder
    getTokensPerFillBuilder()
    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.
    boolean
    hasTokensPerFill()
    The number of tokens added to the bucket during each fill interval.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder>
    internalGetFillIntervalFieldBuilder()
    The fill interval that tokens are added to the bucket.
    private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder>
    internalGetTokensPerFillFieldBuilder()
    The number of tokens added to the bucket during each fill interval.
    final boolean
    isInitialized()
     
    private void
    maybeForceBuilderInitialization()
     
    TokenBucket.Builder
    mergeFillInterval(com.google.protobuf.Duration value)
    The fill interval that tokens are added to the bucket.
    TokenBucket.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    TokenBucket.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    TokenBucket.Builder
    mergeFrom(TokenBucket other)
     
    TokenBucket.Builder
    mergeTokensPerFill(com.google.protobuf.UInt32Value value)
    The number of tokens added to the bucket during each fill interval.
    TokenBucket.Builder
    setFillInterval(com.google.protobuf.Duration value)
    The fill interval that tokens are added to the bucket.
    TokenBucket.Builder
    setFillInterval(com.google.protobuf.Duration.Builder builderForValue)
    The fill interval that tokens are added to the bucket.
    TokenBucket.Builder
    setMaxTokens(int value)
    The maximum tokens that the bucket can hold.
    TokenBucket.Builder
    setTokensPerFill(com.google.protobuf.UInt32Value value)
    The number of tokens added to the bucket during each fill interval.
    TokenBucket.Builder
    setTokensPerFill(com.google.protobuf.UInt32Value.Builder builderForValue)
    The number of tokens added to the bucket during each fill interval.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • bitField0_

      private int bitField0_

    • maxTokens_

      private int maxTokens_

    • tokensPerFill_

      private com.google.protobuf.UInt32Value tokensPerFill_

    • tokensPerFillBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder> tokensPerFillBuilder_

    • fillInterval_

      private com.google.protobuf.Duration fillInterval_

    • fillIntervalBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder> fillIntervalBuilder_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

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

    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()

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

    • buildPartial0

      private void buildPartial0(TokenBucket result)

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

    • mergeFrom

      public TokenBucket.Builder mergeFrom(TokenBucket other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • internalGetTokensPerFillFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value, com.google.protobuf.UInt32Value.Builder, com.google.protobuf.UInt32ValueOrBuilder> internalGetTokensPerFillFieldBuilder()
      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) = { ... }

    • 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

    • internalGetFillIntervalFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Duration, com.google.protobuf.Duration.Builder, com.google.protobuf.DurationOrBuilder> internalGetFillIntervalFieldBuilder()
      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) = { ... }