Attributes of a usage quota.

Hierarchy

  • UsageQuotaResponseAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
enforced: boolean

Whether usage above the limit is actively blocked instead of only tracked or alerted on.

orgPublicId: string

The public ID of the organization that owns the quota.

scope?: {
    [key: string]: string;
}

A namespace-specific key and value identifying what the quota applies to within an organization. The object contains exactly one entry. A value of "*" identifies the default quota applied to entities without a specific quota. This field is omitted for an organization-wide quota.

Type declaration

  • [key: string]: string
usageLimit: number

The quota limit in the usage units defined by the quota namespace. May be fractional for quotas configured before public writes required whole units.

Generated using TypeDoc