InstanceMaintenanceEventSummary

class oci.core.models.InstanceMaintenanceEventSummary(**kwargs)

Bases: object

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

Attributes

ALTERNATIVE_RESOLUTION_ACTIONS_REBOOT_MIGRATION A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEventSummary.
ALTERNATIVE_RESOLUTION_ACTIONS_TERMINATE A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEventSummary.
alternative_resolution_actions [Required] Gets the alternative_resolution_actions of this InstanceMaintenanceEventSummary.
can_reschedule [Required] Gets the can_reschedule of this InstanceMaintenanceEventSummary.
compartment_id [Required] Gets the compartment_id of this InstanceMaintenanceEventSummary.
correlation_token Gets the correlation_token of this InstanceMaintenanceEventSummary.
created_by [Required] Gets the created_by of this InstanceMaintenanceEventSummary.
defined_tags Gets the defined_tags of this InstanceMaintenanceEventSummary.
description Gets the description of this InstanceMaintenanceEventSummary.
display_name Gets the display_name of this InstanceMaintenanceEventSummary.
estimated_duration Gets the estimated_duration of this InstanceMaintenanceEventSummary.
freeform_tags Gets the freeform_tags of this InstanceMaintenanceEventSummary.
id [Required] Gets the id of this InstanceMaintenanceEventSummary.
instance_action [Required] Gets the instance_action of this InstanceMaintenanceEventSummary.
instance_id [Required] Gets the instance_id of this InstanceMaintenanceEventSummary.
lifecycle_state [Required] Gets the lifecycle_state of this InstanceMaintenanceEventSummary.
maintenance_category [Required] Gets the maintenance_category of this InstanceMaintenanceEventSummary.
maintenance_reason [Required] Gets the maintenance_reason of this InstanceMaintenanceEventSummary.
start_window_duration Gets the start_window_duration of this InstanceMaintenanceEventSummary.
time_created [Required] Gets the time_created of this InstanceMaintenanceEventSummary.
time_finished Gets the time_finished of this InstanceMaintenanceEventSummary.
time_hard_due_date Gets the time_hard_due_date of this InstanceMaintenanceEventSummary.
time_started Gets the time_started of this InstanceMaintenanceEventSummary.
time_window_start [Required] Gets the time_window_start of this InstanceMaintenanceEventSummary.

Methods

__init__(**kwargs) Initializes a new InstanceMaintenanceEventSummary object with values from keyword arguments.
ALTERNATIVE_RESOLUTION_ACTIONS_REBOOT_MIGRATION = 'REBOOT_MIGRATION'

A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEventSummary. This constant has a value of “REBOOT_MIGRATION”

ALTERNATIVE_RESOLUTION_ACTIONS_TERMINATE = 'TERMINATE'

A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEventSummary. This constant has a value of “TERMINATE”

__init__(**kwargs)

Initializes a new InstanceMaintenanceEventSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this InstanceMaintenanceEventSummary.
  • display_name (str) – The value to assign to the display_name property of this InstanceMaintenanceEventSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this InstanceMaintenanceEventSummary.
  • id (str) – The value to assign to the id property of this InstanceMaintenanceEventSummary.
  • instance_id (str) – The value to assign to the instance_id property of this InstanceMaintenanceEventSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this InstanceMaintenanceEventSummary.
  • maintenance_category (str) – The value to assign to the maintenance_category property of this InstanceMaintenanceEventSummary.
  • maintenance_reason (str) – The value to assign to the maintenance_reason property of this InstanceMaintenanceEventSummary.
  • instance_action (str) – The value to assign to the instance_action property of this InstanceMaintenanceEventSummary.
  • alternative_resolution_actions (list[str]) – The value to assign to the alternative_resolution_actions property of this InstanceMaintenanceEventSummary. Allowed values for items in this list are: “REBOOT_MIGRATION”, “TERMINATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_started (datetime) – The value to assign to the time_started property of this InstanceMaintenanceEventSummary.
  • time_finished (datetime) – The value to assign to the time_finished property of this InstanceMaintenanceEventSummary.
  • time_window_start (datetime) – The value to assign to the time_window_start property of this InstanceMaintenanceEventSummary.
  • start_window_duration (str) – The value to assign to the start_window_duration property of this InstanceMaintenanceEventSummary.
  • estimated_duration (str) – The value to assign to the estimated_duration property of this InstanceMaintenanceEventSummary.
  • time_hard_due_date (datetime) – The value to assign to the time_hard_due_date property of this InstanceMaintenanceEventSummary.
  • can_reschedule (bool) – The value to assign to the can_reschedule property of this InstanceMaintenanceEventSummary.
  • time_created (datetime) – The value to assign to the time_created property of this InstanceMaintenanceEventSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this InstanceMaintenanceEventSummary.
  • created_by (str) – The value to assign to the created_by property of this InstanceMaintenanceEventSummary.
  • description (str) – The value to assign to the description property of this InstanceMaintenanceEventSummary.
  • correlation_token (str) – The value to assign to the correlation_token property of this InstanceMaintenanceEventSummary.
alternative_resolution_actions

[Required] Gets the alternative_resolution_actions of this InstanceMaintenanceEventSummary. These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.

Allowed values for items in this list are: “REBOOT_MIGRATION”, “TERMINATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The alternative_resolution_actions of this InstanceMaintenanceEventSummary.
Return type:list[str]
can_reschedule

[Required] Gets the can_reschedule of this InstanceMaintenanceEventSummary. Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.

Returns:The can_reschedule of this InstanceMaintenanceEventSummary.
Return type:bool
compartment_id

[Required] Gets the compartment_id of this InstanceMaintenanceEventSummary. The OCID of the compartment that contains the instance.

Returns:The compartment_id of this InstanceMaintenanceEventSummary.
Return type:str
correlation_token

Gets the correlation_token of this InstanceMaintenanceEventSummary. 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.

Returns:The correlation_token of this InstanceMaintenanceEventSummary.
Return type:str
created_by

[Required] Gets the created_by of this InstanceMaintenanceEventSummary. The creator of the maintenance event.

Returns:The created_by of this InstanceMaintenanceEventSummary.
Return type:str
defined_tags

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

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:The defined_tags of this InstanceMaintenanceEventSummary.
Return type:dict(str, dict(str, object))
description

Gets the description of this InstanceMaintenanceEventSummary. It is the descriptive information about the maintenance taking place on the customer instance.

Returns:The description of this InstanceMaintenanceEventSummary.
Return type:str
display_name

Gets the display_name of this InstanceMaintenanceEventSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this InstanceMaintenanceEventSummary.
Return type:str
estimated_duration

Gets the estimated_duration of this InstanceMaintenanceEventSummary. This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.

Returns:The estimated_duration of this InstanceMaintenanceEventSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this InstanceMaintenanceEventSummary. 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: {“Department”: “Finance”}

Returns:The freeform_tags of this InstanceMaintenanceEventSummary.
Return type:dict(str, str)
id

[Required] Gets the id of this InstanceMaintenanceEventSummary. The OCID of the maintenance event.

Returns:The id of this InstanceMaintenanceEventSummary.
Return type:str
instance_action

[Required] Gets the instance_action of this InstanceMaintenanceEventSummary. This is the action that will be performed on the Instance by OCI when the Maintenance begins.

Returns:The instance_action of this InstanceMaintenanceEventSummary.
Return type:str
instance_id

[Required] Gets the instance_id of this InstanceMaintenanceEventSummary. The OCID of the instance.

Returns:The instance_id of this InstanceMaintenanceEventSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this InstanceMaintenanceEventSummary. The current state of the maintenance event.

Returns:The lifecycle_state of this InstanceMaintenanceEventSummary.
Return type:str
maintenance_category

[Required] Gets the maintenance_category of this InstanceMaintenanceEventSummary. 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.

Returns:The maintenance_category of this InstanceMaintenanceEventSummary.
Return type:str
maintenance_reason

[Required] Gets the maintenance_reason of this InstanceMaintenanceEventSummary. This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.

Returns:The maintenance_reason of this InstanceMaintenanceEventSummary.
Return type:str
start_window_duration

Gets the start_window_duration of this InstanceMaintenanceEventSummary. The duration of the time window Maintenance is scheduled to begin within.

Returns:The start_window_duration of this InstanceMaintenanceEventSummary.
Return type:str
time_created

[Required] Gets the time_created of this InstanceMaintenanceEventSummary. The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this InstanceMaintenanceEventSummary.
Return type:datetime
time_finished

Gets the time_finished of this InstanceMaintenanceEventSummary. The time at which the Maintenance actually finished.

Returns:The time_finished of this InstanceMaintenanceEventSummary.
Return type:datetime
time_hard_due_date

Gets the time_hard_due_date of this InstanceMaintenanceEventSummary. 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.

Returns:The time_hard_due_date of this InstanceMaintenanceEventSummary.
Return type:datetime
time_started

Gets the time_started of this InstanceMaintenanceEventSummary. The time at which the Maintenance actually started.

Returns:The time_started of this InstanceMaintenanceEventSummary.
Return type:datetime
time_window_start

[Required] Gets the time_window_start of this InstanceMaintenanceEventSummary. The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

Returns:The time_window_start of this InstanceMaintenanceEventSummary.
Return type:datetime