Maintenance

data class Maintenance(
    val description: String,
    val availability: Maintenance.Availability,
    val startsAt: Long,
    val estimatedEndsAt: Long?,
)

Properties

description: String A description of the scheduled/ongoing maintenance.

The text may contain any type of character, but the operator should keep in mind that this will be displayed in a web-application. This text should be kept to only a single paragraph, but it may contain line-breaks as needed. This text must not be blank. The Core will require that this text contains at most 4000 characters.

availability: Maintenance.Availability Describes the availability of the affected service.

startsAt: Long Describes when the maintenance is expected to start.

This is an ordinary UCloud timestamp (millis since unix epoch). The timestamp can be in the future (or past). But, the Core will enforce that the maintenance is in the “recent” past to ensure that the timestamp is not incorrect.

estimatedEndsAt: Long? Describes when the maintenance is expected to end.

This property is optional and can be left blank. In this case, users will not be notified about when the maintenance is expected to end. This can be useful if a product is reaching EOL. In either case, the description should be used to clarify the meaning of this property.

This is an ordinary UCloud timestamp (millis since unix epoch). The timestamp can be in the future (or past). But, the Core will enforce that the maintenance is in the “recent” past to ensure that the timestamp is not incorrect.