models.bandwidth_limit module

class models.bandwidth_limit.BandwidthLimit(bandwidth_limit_overrides=None, io_rate=None, rate_limit_bytes_per_sec=None, timezone=None)[source]

Bases: object

Implementation of the ‘BandwidthLimit’ model.

Specifies settings for limiting the data transfer rate between the local and remote Clusters.

Attributes:
bandwidth_limit_overrides (list of BandwidthLimitOverride): Array of

Override Bandwidth Limits. Specifies a list of override bandwidth limits and time periods when those limits override the rateLimitBytesPerSec limit. If overlapping time periods are specified, the last one in the array takes precedence.

io_rate (int): Specifies the default IO Rate of the throttling

schedule. This value is internally mapped to some notion of how many resources a process should be consuming.

rate_limit_bytes_per_sec (long|int): Specifies the maximum allowed

data transfer rate between the local Cluster and remote Clusters. The value is specified in bytes per second. If not set, the data transfer rate is not limited.

timezone (string): Specifies a time zone for the specified time

period. The time zone is defined in the following format: “Area/Location”, for example: “America/New_York”.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.