Class: Quota

Quota()

A Quota Model represents a single instance of a Quota object from the DataONE Bookkeeper data model. Quotas are limits set for a particular Product, such as the number of portals allowed, disk space allowed, etc. Quotas have a soft and hard limit per unit to help with communicating limit warnings. See https://github.com/DataONEorg/bookkeeper for documentation on the DataONE Bookkeeper service and data model.

Constructor

new Quota()

Since:
  • 2.14.0
Source:

Members

defaults :Object

Default attributes for Quota models
Type:
  • Object
Properties:
Name Type Description
id string The unique id of this Quota, from Bookkeeper
quotaType string The quotaType of this Quota type
quotaTypeOptions Array.<string> The controlled list of `quotaType` values that can be set on a Quota model
object string The name of this type of Bookkeeper object, which will always be "quota"
softLimit number The soft quota limit, which may be surpassed under certain conditions
hardLimit number The hard quota limit, which cannot be surpassed
unit string The unit of each Usage of this Quota (e.g. bytes, portals)
unitOptions Array.<string> The controlled list of `unit` values that can be set on a Quota model
customerId string The id of the Customer associated with this Quota
subject string The user or group subject associated with this Quota
totalUsage number The total or sum of usage of this Quota
Source:

type :string

The name of this type of model
Type:
  • string
Source: