Type Alias Quota

type Quota = {
    attributes: {
        quota: number;
        unit: string;
        usage?: number;
        warningThresholds?: number[];
    };
    id: string;
    type: string;
}
Index

Properties

attributes id type

Properties

attributes: {
    quota: number;
    unit: string;
    usage?: number;
    warningThresholds?: number[];
}

The attributes of the quota.

Type declaration

  • quota: number

    The quota limit. If there is no quota limit, -1 is returned.

  • unit: string

    The unit of the quota limit. For memory quotas, the unit is always "bytes". For other discrete units, the item counted is used as unit, for example "spaces".

  • Optionalusage?: number

    The current quota usage, if applicable. This attribute is only present if it is requested using the reportUsage query parameter.

  • OptionalwarningThresholds?: number[]

    The warning thresholds at which "close to quota" warnings can be issued when exceeded. If omitted, no warning threshold shall be used. Currently, the array will contain only one threshold value. In the future, this may be extended. The threshold is a number between 0 and 1, relating to the quota limit. For example, a value of 0.9 means that a warning should be issued when exceeding 90% of the quota limit.

id: string

The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

type: string

The resource type of the quota item. Always equal to "quotas".

Settings

Member Visibility

On This Page

Properties