Class: Usage

Usage()

A Usage Model represents a single instance of a Usage object from the DataONE Bookkeeper data model. A Usage tracks which objects use a portion of a Quota. A Quota can be associated with multiple Usages. See https://github.com/DataONEorg/bookkeeper for documentation on the DataONE Bookkeeper service and data model.

Constructor

new Usage()

Since:
  • 2.14.0
Source:

Members

defaults :Object

Default attributes for Usage models
Type:
  • Object
Properties:
Name Type Description
id string The unique id of this Usage, from Bookkeeper
object string The name of this type of Bookkeeper object, which will always be "usage"
quotaId number The id of the Quota object that this Usage is associated with, from Bookkeeper. This is a match to Quota#defaults#id
instanceId string The id of the DataONEObject that makes up this Usage
quantity number The quantity of the Quota that this Usage uses, expressed as Quota#defaults#unit
status string The status of this Usage
statusOptions Array.<string> The controlled list of `status` values that can be set on a Usage model
nodeId string The Member Node ID that the object is from
DataONEObject DataONEObject A reference to the DataONEObject that has the id/seriesId of this Usage instanceId
SolrResult SolrResult A reference to the SolrResult that has the id/seriesId of this Usage instanceId
Source:

type :string

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