Class InstanceMaintenanceEvent
It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.
Inherited Members
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class InstanceMaintenanceEvent
Properties
AdditionalDetails
Declaration
[JsonProperty(PropertyName = "additionalDetails")]
public Dictionary<string, string> AdditionalDetails { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Additional details of the maintenance in the form of json. |
AlternativeResolutionActions
Declaration
[Required(ErrorMessage = "AlternativeResolutionActions is required.")]
[JsonProperty(PropertyName = "alternativeResolutionActions", ItemConverterType = typeof(ResponseEnumConverter))]
public List<InstanceMaintenanceAlternativeResolutionActions> AlternativeResolutionActions { get; set; }
Property Value
Type | Description |
---|---|
List<InstanceMaintenanceAlternativeResolutionActions> | These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance. |
Remarks
Required
CanDeleteLocalStorage
Declaration
[JsonProperty(PropertyName = "canDeleteLocalStorage")]
public bool? CanDeleteLocalStorage { get; set; }
Property Value
Type | Description |
---|---|
bool? | 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
Declaration
[Required(ErrorMessage = "CanReschedule is required.")]
[JsonProperty(PropertyName = "canReschedule")]
public bool? CanReschedule { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate. |
Remarks
Required
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment that contains the instance. |
Remarks
Required
CorrelationToken
Declaration
[JsonProperty(PropertyName = "correlationToken")]
public string CorrelationToken { get; set; }
Property Value
Type | 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. |
CreatedBy
Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstanceMaintenanceEvent.CreatedByEnum? CreatedBy { get; set; }
Property Value
Type | Description |
---|---|
InstanceMaintenanceEvent.CreatedByEnum? | The creator of the maintenance event. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags.
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | It is the descriptive information about the maintenance taking place on the customer instance. |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
EstimatedDuration
Declaration
[JsonProperty(PropertyName = "estimatedDuration")]
public string EstimatedDuration { get; set; }
Property Value
Type | Description |
---|---|
string | This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | 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.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the maintenance event. |
Remarks
Required
InstanceAction
Declaration
[Required(ErrorMessage = "InstanceAction is required.")]
[JsonProperty(PropertyName = "instanceAction")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstanceMaintenanceEvent.InstanceActionEnum? InstanceAction { get; set; }
Property Value
Type | Description |
---|---|
InstanceMaintenanceEvent.InstanceActionEnum? | This is the action that will be performed on the Instance by OCI when the Maintenance begins. |
Remarks
Required
InstanceId
Declaration
[Required(ErrorMessage = "InstanceId is required.")]
[JsonProperty(PropertyName = "instanceId")]
public string InstanceId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the instance. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | Provides more details about the state of the maintenance event. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstanceMaintenanceEvent.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
InstanceMaintenanceEvent.LifecycleStateEnum? | The current state of the maintenance event. |
Remarks
Required
MaintenanceCategory
Declaration
[Required(ErrorMessage = "MaintenanceCategory is required.")]
[JsonProperty(PropertyName = "maintenanceCategory")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstanceMaintenanceEvent.MaintenanceCategoryEnum? MaintenanceCategory { get; set; }
Property Value
Type | Description |
---|---|
InstanceMaintenanceEvent.MaintenanceCategoryEnum? | 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. |
Remarks
Required
MaintenanceReason
Declaration
[Required(ErrorMessage = "MaintenanceReason is required.")]
[JsonProperty(PropertyName = "maintenanceReason")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstanceMaintenanceEvent.MaintenanceReasonEnum? MaintenanceReason { get; set; }
Property Value
Type | Description |
---|---|
InstanceMaintenanceEvent.MaintenanceReasonEnum? | This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details. |
Remarks
Required
StartWindowDuration
Declaration
[JsonProperty(PropertyName = "startWindowDuration")]
public string StartWindowDuration { get; set; }
Property Value
Type | Description |
---|---|
string | The duration of the time window Maintenance is scheduled to begin within. |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
Remarks
Required
TimeFinished
Declaration
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time at which the Maintenance actually finished. |
TimeHardDueDate
Declaration
[JsonProperty(PropertyName = "timeHardDueDate")]
public DateTime? TimeHardDueDate { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | 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. |
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time at which the Maintenance actually started. |
TimeWindowStart
Declaration
[Required(ErrorMessage = "TimeWindowStart is required.")]
[JsonProperty(PropertyName = "timeWindowStart")]
public DateTime? TimeWindowStart { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time. |
Remarks
Required