/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time. * */ export interface InstanceMaintenanceEvent { /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * Defined tags for this resource. Each key is predefined and scoped to a * namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event. * */ "id": string; /** * The OCID of the instance. */ "instanceId": string; /** * The OCID of the compartment that contains the instance. * */ "compartmentId": string; /** * 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](https://docs.oracle.com/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. * */ "maintenanceCategory": InstanceMaintenanceEvent.MaintenanceCategory; /** * This is the reason that Maintenance is being performed. See * [Instance Maintenance](https://docs.oracle.com/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details. * */ "maintenanceReason": InstanceMaintenanceEvent.MaintenanceReason; /** * This is the action that will be performed on the Instance by OCI when the Maintenance begins. * */ "instanceAction": InstanceMaintenanceEvent.InstanceAction; /** * These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance. * */ "alternativeResolutionActions": Array; /** * The time at which the Maintenance actually started. * */ "timeStarted"?: Date; /** * The time at which the Maintenance actually finished. * */ "timeFinished"?: Date; /** * The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before * this time. * */ "timeWindowStart": Date; /** * The duration of the time window Maintenance is scheduled to begin within. * */ "startWindowDuration"?: string; /** * This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state. * */ "estimatedDuration"?: string; /** * 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. * */ "timeHardDueDate"?: Date; /** * Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate. * */ "canReschedule": boolean; /** * The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). * Example: {@code 2016-08-25T21:10:29.600Z} * */ "timeCreated": Date; /** * The current state of the maintenance event. * */ "lifecycleState": InstanceMaintenanceEvent.LifecycleState; /** * Provides more details about the state of the maintenance event. * */ "lifecycleDetails"?: string; /** * The creator of the maintenance event. * */ "createdBy": InstanceMaintenanceEvent.CreatedBy; /** * It is the descriptive information about the maintenance taking place on the customer instance. * */ "description"?: 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. * */ "correlationToken"?: string; /** * For Instances that have local storage, this field is set to true when local storage * will be deleted as a result of the Maintenance. * */ "canDeleteLocalStorage"?: boolean; /** * Additional details of the maintenance in the form of json. * */ "additionalDetails"?: { [key: string]: string; }; } export declare namespace InstanceMaintenanceEvent { enum MaintenanceCategory { Emergency = "EMERGENCY", Mandatory = "MANDATORY", Flexible = "FLEXIBLE", Optional = "OPTIONAL", Notification = "NOTIFICATION", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum MaintenanceReason { Evacuation = "EVACUATION", EnvironmentalFactors = "ENVIRONMENTAL_FACTORS", Decommission = "DECOMMISSION", HardwareReplacement = "HARDWARE_REPLACEMENT", FirmwareUpdate = "FIRMWARE_UPDATE", SecurityUpdate = "SECURITY_UPDATE", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum InstanceAction { RebootMigration = "REBOOT_MIGRATION", Terminate = "TERMINATE", Stop = "STOP", None = "NONE", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum AlternativeResolutionActions { RebootMigration = "REBOOT_MIGRATION", Terminate = "TERMINATE", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum LifecycleState { Scheduled = "SCHEDULED", Queued = "QUEUED", Started = "STARTED", Processing = "PROCESSING", Succeeded = "SUCCEEDED", Failed = "FAILED", Canceled = "CANCELED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum CreatedBy { Customer = "CUSTOMER", System = "SYSTEM", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: InstanceMaintenanceEvent): object; function getDeserializedJsonObj(obj: InstanceMaintenanceEvent): object; }