Class UsageQuotaBulkResultAttributes

Attributes of a usage quota bulk write result. On success, all fields except error are present. On failure, only error is present and the other fields are omitted.

Hierarchy

  • UsageQuotaBulkResultAttributes

Constructors

constructor

Properties

additionalProperties? enforced? error? orgPublicId? 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

Optional enforced

enforced?: boolean

Whether usage above the limit is actively blocked instead of only tracked or alerted on. Omitted if this item failed to write.

Optional error

error?: string

An error message describing why this item failed to write. Omitted if this item was written successfully.

Optional orgPublicId

orgPublicId?: string

The public ID of the organization that owns the quota. Omitted if this item failed to write.

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 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

Optional 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. Omitted if this item failed to write.

Settings

Member Visibility

Theme

Generated using TypeDoc