Skip to content

Latest commit

 

History

History
113 lines (66 loc) · 3.53 KB

quota.schema.md

File metadata and controls

113 lines (66 loc) · 3.53 KB

Storage Quota Schema

https://ns.adobe.com/xdm/content/repository-policies/quota

Quota policy represents how storage consumption is managed and monitored in a given part of the repository. Quota is expressed as two values: Quota Amount (amount) and Current Consumption (consumed). The former represents a limit of storage space that can be allocated in the directory and its descendants. The latter represents the storage space that is currently allocated. Furthermore, Storage Quota can be either hard or soft via the 'enforcement' property. If a hard Storage Quota is set, the repository implementation will not allow clients to allocate storage beyond the Quota Amount. Repository implementations can generate notifications or alerts when the consumed space in a part of the repository for which a (hard or soft) quota has been defined exceeds a given percentage (e.g. 80%) of the Quota Amount.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Cannot be instantiated Yes Experimental No Forbidden Permitted content/repository-policies/quota.schema.json

Storage Quota Example

{
  "xdm:enforcement": "hard",
  "xdm:amount": 1099511627776,
  "xdm:consumed": 21474836480,
  "xdm:unit": "Bytes"
}

Storage Quota Definitions

Property Type Group
xdm:amount number https://ns.adobe.com/xdm/content/repository-policies/quota#/definitions/quota
xdm:consumed number https://ns.adobe.com/xdm/content/repository-policies/quota#/definitions/quota
xdm:enforcement enum https://ns.adobe.com/xdm/content/repository-policies/quota#/definitions/quota
xdm:unit const https://ns.adobe.com/xdm/content/repository-policies/quota#/definitions/quota

xdm:amount

The quota against which consumption is measured at the point of the repository that links to this document.

xdm:amount

  • is optional
  • type: number
  • defined in this schema

xdm:amount Type

number

  • minimum value: 0

xdm:consumed

The amount currently consumed against the quota at the point of the repository that links to this document.

xdm:consumed

  • is optional
  • type: number
  • defined in this schema

xdm:consumed Type

number

xdm:enforcement

Determines whether the quota is being enforced (hard quota) or only reported on (soft quota).

xdm:enforcement

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:enforcement Known Values

Value Description
hard
soft

xdm:unit

The unit that is used to determine the quota and measure consumption. This property is optional, but fixed, i.e. it allows consumers to quickly understand the value just by looking at the JSON response from the API.

xdm:unit

  • is optional
  • type: const
  • defined in this schema

The value of this property must be equal to:

"Bytes"