TrafficShapingConfig class

  • TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced.

This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.

Constructors

TrafficShapingConfig.new({String? duration, String? quotaLimit})
TrafficShapingConfig.fromJson(Map json_)

Properties

duration ↔ String?
  • The duration over which the API call quota limits are calculated.
    • getter/setter pair
    hashCode → int
    The hash code for this object.
    no setterinherited
    quotaLimit ↔ String?
    Maximum number of api calls allowed.
    getter/setter pair
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited

    Methods

    noSuchMethod(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
    inherited
    toJson() → Map<String, dynamic>
    toString() → String
    A string representation of this object.
    inherited

    Operators

    operator ==(Object other) → bool
    The equality operator.
    inherited