Interface TokenBucketOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TokenBucket, TokenBucket.Builder

    public interface TokenBucketOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.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.
      boolean hasTokensPerFill()
      The number of tokens added to the bucket during each fill interval.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getMaxTokens

        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) = { ... }
        Returns:
        The maxTokens.
      • hasTokensPerFill

        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) = { ... }
        Returns:
        Whether the tokensPerFill field is set.
      • getTokensPerFill

        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) = { ... }
        Returns:
        The tokensPerFill.
      • getTokensPerFillOrBuilder

        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) = { ... }
      • hasFillInterval

        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) = { ... }
        Returns:
        Whether the fillInterval field is set.
      • getFillInterval

        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) = { ... }
        Returns:
        The fillInterval.
      • getFillIntervalOrBuilder

        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) = { ... }