MaintenanceEventResourceProperties interface
Properties of a maintenance event resource.
Properties
| deferrable | A value indicating whether this maintenance event can be rescheduled by the customer. |
| deferral |
The latest date/time this maintenance event can be postponed to (UTC). Present only when deferrable is true. |
| description | The human-readable description of the maintenance event. |
| end |
The scheduled end time of the maintenance event (UTC). |
| estimated |
The estimated downtime as an ISO 8601 duration string (e.g., 'PT60S' = 60 seconds). |
| last |
The time this maintenance event record was last updated (UTC). |
| maintenance |
A service-generated identifier for this maintenance event, assigned by the platform (e.g., 'YL1T-HFG'). The format is not contractual and clients should not attempt to parse or construct this value. |
| maintenance |
The maintenance type (e.g., 'PlannedMaintenance'). |
| original |
The initial scheduled start time before any reschedule (UTC). Equals startTime when the event has never been rescheduled. |
| rescheduled |
The previous scheduled start time before the most recent reschedule (UTC). Null if the event has never been rescheduled. |
| start |
The scheduled start time of the maintenance event (UTC). |
| status | The customer-facing status of the maintenance event. |
Property Details
deferrable
A value indicating whether this maintenance event can be rescheduled by the customer.
deferrable: boolean
Property Value
boolean
deferralDeadline
The latest date/time this maintenance event can be postponed to (UTC). Present only when deferrable is true.
deferralDeadline?: Date
Property Value
Date
description
The human-readable description of the maintenance event.
description?: string
Property Value
string
endTime
The scheduled end time of the maintenance event (UTC).
endTime: Date
Property Value
Date
estimatedDowntime
The estimated downtime as an ISO 8601 duration string (e.g., 'PT60S' = 60 seconds).
estimatedDowntime?: string
Property Value
string
lastUpdatedTime
The time this maintenance event record was last updated (UTC).
lastUpdatedTime?: Date
Property Value
Date
maintenanceEventId
A service-generated identifier for this maintenance event, assigned by the platform (e.g., 'YL1T-HFG'). The format is not contractual and clients should not attempt to parse or construct this value.
maintenanceEventId?: string
Property Value
string
maintenanceType
The maintenance type (e.g., 'PlannedMaintenance').
maintenanceType: string
Property Value
string
originalStartTime
The initial scheduled start time before any reschedule (UTC). Equals startTime when the event has never been rescheduled.
originalStartTime: Date
Property Value
Date
rescheduledFrom
The previous scheduled start time before the most recent reschedule (UTC). Null if the event has never been rescheduled.
rescheduledFrom?: Date
Property Value
Date
startTime
The scheduled start time of the maintenance event (UTC).
startTime: Date
Property Value
Date
status
The customer-facing status of the maintenance event.
status: string
Property Value
string