Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface ThrottleBucketOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
ThrottleBucket, ThrottleBucket.Builder
@Generated public interface ThrottleBucketOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBurstPeriodMs()
    * A burst duration limit, in milliseconds.<br/> This value determines the total "capacity" of the bucket.
    boolean
    getHighVolume()
    * If set to true, this bucket is used for high-volume throttles.
    String
    getName()
    * A name for this bucket.<br/> This is used for log entries.
    com.google.protobuf.ByteString
    getNameBytes()
    * A name for this bucket.<br/> This is used for log entries.
    ThrottleGroup
    getThrottleGroups(int index)
    * A list of throttle groups.<br/> These throttle groups combined define the effective throttle rate for the bucket.
    int
    getThrottleGroupsCount()
    * A list of throttle groups.<br/> These throttle groups combined define the effective throttle rate for the bucket.
    List<ThrottleGroup>
    getThrottleGroupsList()
    * A list of throttle groups.<br/> These throttle groups combined define the effective throttle rate for the bucket.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getName

      String getName()
       *
 A name for this bucket.<br/>
 This is used for log entries.
 <p>
 This value SHOULD NOT exceed 20 characters.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       *
 A name for this bucket.<br/>
 This is used for log entries.
 <p>
 This value SHOULD NOT exceed 20 characters.
      string name = 1;
      Returns:
      The bytes for name.

    • getBurstPeriodMs

      long getBurstPeriodMs()
       *
 A burst duration limit, in milliseconds.<br/>
 This value determines the total "capacity" of the bucket. The rate
 at which the bucket "drains" is set by the throttles, and this duration
 sets how long that rate must be sustained to empty a "full" bucket.
 That combination (calculated as the product of this value and the least
 common multiple of the `milliOpsPerSec` values for all throttle groups)
 determines the maximum amount of operations this bucket can "hold".
 <p>
 The calculated capacity of this bucket MUST NOT exceed `9,223,372,036,854`.
      uint64 burstPeriodMs = 2;
      Returns:
      The burstPeriodMs.

    • getThrottleGroupsList

      List<ThrottleGroup> getThrottleGroupsList()
       *
 A list of throttle groups.<br/>
 These throttle groups combined define the effective throttle
 rate for the bucket.
 <p>
 This list MUST contain at least one entry.
      repeated .proto.ThrottleGroup throttleGroups = 3;

    • getThrottleGroups

      ThrottleGroup getThrottleGroups(int index)
       *
 A list of throttle groups.<br/>
 These throttle groups combined define the effective throttle
 rate for the bucket.
 <p>
 This list MUST contain at least one entry.
      repeated .proto.ThrottleGroup throttleGroups = 3;

    • getThrottleGroupsCount

      int getThrottleGroupsCount()
       *
 A list of throttle groups.<br/>
 These throttle groups combined define the effective throttle
 rate for the bucket.
 <p>
 This list MUST contain at least one entry.
      repeated .proto.ThrottleGroup throttleGroups = 3;

    • getHighVolume

      boolean getHighVolume()
       *
 If set to true, this bucket is used for high-volume throttles.
      bool high_volume = 4;
      Returns:
      The highVolume.