Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace InstanceMaintenanceEvent

It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.

Properties

Optional additionalDetails

additionalDetails: undefined | object

Additional details of the maintenance in the form of json.

alternativeResolutionActions

alternativeResolutionActions: Array<AlternativeResolutionActions>

These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.

Optional canDeleteLocalStorage

canDeleteLocalStorage: undefined | false | true

For Instances that have local storage, this field is set to true when local storage will be deleted as a result of the Maintenance.

canReschedule

canReschedule: boolean

Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.

compartmentId

compartmentId: string

The OCID of the compartment that contains the instance.

Optional correlationToken

correlationToken: undefined | string

A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.

createdBy

createdBy: CreatedBy

The creator of the maintenance event.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

It is the descriptive information about the maintenance taking place on the customer instance.

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional estimatedDuration

estimatedDuration: undefined | string

This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the maintenance event.

instanceAction

instanceAction: InstanceAction

This is the action that will be performed on the Instance by OCI when the Maintenance begins.

instanceId

instanceId: string

The OCID of the instance.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Provides more details about the state of the maintenance event.

lifecycleState

lifecycleState: LifecycleState

The current state of the maintenance event.

maintenanceCategory

maintenanceCategory: MaintenanceCategory

This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.

maintenanceReason

maintenanceReason: MaintenanceReason

This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.

Optional startWindowDuration

startWindowDuration: undefined | string

The duration of the time window Maintenance is scheduled to begin within.

timeCreated

timeCreated: Date

The date and time the maintenance event was created, in the format defined by RFC3339. Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeFinished

timeFinished: Date

The time at which the Maintenance actually finished.

Optional timeHardDueDate

timeHardDueDate: Date

It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.

Optional timeStarted

timeStarted: Date

The time at which the Maintenance actually started.

timeWindowStart

timeWindowStart: Date

The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

Functions

getDeserializedJsonObj

getJsonObj