Class MaintenanceWindowAttributes

Attributes of a maintenance window, including its schedule and the query that determines which cases are affected.

Hierarchy

  • MaintenanceWindowAttributes

Constructors

constructor

Properties

additionalProperties? createdBy? endAt name query startAt updatedBy?

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 createdBy

createdBy?: string

The UUID of the user who created this maintenance window. Read-only.

endAt

endAt: Date

The ISO 8601 timestamp when the maintenance window ends and normal notification behavior resumes.

name

name: string

A human-readable name for the maintenance window (for example, Database migration - Dec 15).

query

query: string

A case search query that determines which cases are affected during the maintenance window. Uses the same syntax as the Case Management search bar.

startAt

startAt: Date

The ISO 8601 timestamp when the maintenance window begins and notifications start being suppressed.

Optional updatedBy

updatedBy?: string

The UUID of the user who last modified this maintenance window. Read-only.

Settings

Member Visibility

Theme

Generated using TypeDoc