Class UsageQuotaResponseAttributes

Attributes of a usage quota.

Hierarchy

  • UsageQuotaResponseAttributes

Constructors

constructor

Properties

additionalProperties? enforced orgPublicId pendingEffectiveFrom? pendingUsageLimit? scope? usageLimit

Constructors

constructor

Properties

Optional additionalProperties

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

enforced: boolean

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

orgPublicId

orgPublicId: string

The public ID of the organization that owns the quota.

Optional pendingEffectiveFrom

pendingEffectiveFrom?: string

The future UTC month when the scheduled limit takes effect, formatted as YYYY-MM, starting at 00:00 UTC on its first day. Present only together with pending_usage_limit and omitted when no change is scheduled.

Optional pendingUsageLimit

pendingUsageLimit?: number

The usage limit scheduled for the organization-wide quota in the usage units defined by the quota namespace. A value of 0 is valid. At the start of the effective month, this value becomes usage_limit and both pending fields are omitted. Omitted when no change is scheduled.

Optional scope

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 user_handle value of "*" identifies the default quota applied to users without a specific quota. This field is omitted for an organization-wide quota.

Type declaration

  • [key: string]: string

usageLimit

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.

Settings

Member Visibility

Theme

Generated using TypeDoc