Class: Quotas

Quotas()

Quotas are limits set for a particular DataONE 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.

Constructor

new Quotas()

Since:
  • 2.14.0
Source:

Members

model :Backbone.Model

The class/model that is contained in this collection.
Type:
  • Backbone.Model
Source:

queryParams :Array.<string>

A list of query parameters that are supported by the Bookkeeper Quotas API. These query parameters can be passed to Quotas#fetch in the `options` object, and they will be used during the fetch.
Type:
  • Array.<string>
Source:

Methods

fetch(optionsopt)

Fetches a list of Quotas from the DataONE Bookkeeper service, parses them, and stores them on this collection.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties:
Name Type Description
options.quotaType string The quotaType to fetch
options.subscriber string The user or group subject associated with these Quotas
Source:

parse() → {JSON}

Parses the fetch() of this collection. Bookkeeper returns JSON already, so there isn't much parsing to do.
Source:
Returns:
The collection data in JSON form
Type
JSON

url(optionsopt) → {string}

Constructs a URL string for fetching this collection and returns it
Parameters:
Name Type Attributes Description
options Object <optional>
Properties:
Name Type Description
options.quotaType string The Usage quotaType to fetch
options.subscriber string The user or group subject associated with these Quotas
Source:
Returns:
The URL string
Type
string