Class: OCI::Core::Models::UpdateInstanceMaintenanceEventDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/update_instance_maintenance_event_details.rb

Overview

Specifies the properties for updating maintenance due date.

Constant Summary collapse

ALTERNATIVE_RESOLUTION_ACTION_ENUM = 
[
  ALTERNATIVE_RESOLUTION_ACTION_REBOOT_MIGRATION = 'REBOOT_MIGRATION'.freeze,
  ALTERNATIVE_RESOLUTION_ACTION_TERMINATE = 'TERMINATE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateInstanceMaintenanceEventDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_window_start (DateTime) —

    The value to assign to the #time_window_start property

  • :alternative_resolution_action (String) —

    The value to assign to the #alternative_resolution_action property

  • :can_delete_local_storage (BOOLEAN) —

    The value to assign to the #can_delete_local_storage property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.time_window_start = attributes[:'timeWindowStart'] if attributes[:'timeWindowStart']

  raise 'You cannot provide both :timeWindowStart and :time_window_start' if attributes.key?(:'timeWindowStart') && attributes.key?(:'time_window_start')

  self.time_window_start = attributes[:'time_window_start'] if attributes[:'time_window_start']

  self.alternative_resolution_action = attributes[:'alternativeResolutionAction'] if attributes[:'alternativeResolutionAction']

  raise 'You cannot provide both :alternativeResolutionAction and :alternative_resolution_action' if attributes.key?(:'alternativeResolutionAction') && attributes.key?(:'alternative_resolution_action')

  self.alternative_resolution_action = attributes[:'alternative_resolution_action'] if attributes[:'alternative_resolution_action']

  self.can_delete_local_storage = attributes[:'canDeleteLocalStorage'] unless attributes[:'canDeleteLocalStorage'].nil?

  raise 'You cannot provide both :canDeleteLocalStorage and :can_delete_local_storage' if attributes.key?(:'canDeleteLocalStorage') && attributes.key?(:'can_delete_local_storage')

  self.can_delete_local_storage = attributes[:'can_delete_local_storage'] unless attributes[:'can_delete_local_storage'].nil?

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']
end

Instance Attribute Details

#alternative_resolution_action ⇒ String

One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 28

def alternative_resolution_action
  @alternative_resolution_action
end

#can_delete_local_storage ⇒ BOOLEAN

This field is only applicable when setting the alternativeResolutionAction.

For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

In cases where the local storage will be lost, this parameter must be set or the request will fail.

Returns:

  • (BOOLEAN) 


38
39
40
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 38

def can_delete_local_storage
  @can_delete_local_storage
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

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:

  • (Hash<String, Hash<String, Object>>) 


52
53
54
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 52

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 44

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<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.

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

Returns:

  • (Hash<String, String>) 


60
61
62
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 60

def freeform_tags
  @freeform_tags
end

#time_window_start ⇒ DateTime

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

The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

Returns:

  • (DateTime) 


23
24
25
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 23

def time_window_start
  @time_window_start
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_window_start': :'timeWindowStart',
    'alternative_resolution_action': :'alternativeResolutionAction',
    'can_delete_local_storage': :'canDeleteLocalStorage',
    'display_name': :'displayName',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_window_start': :'DateTime',
    'alternative_resolution_action': :'String',
    'can_delete_local_storage': :'BOOLEAN',
    'display_name': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 160

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    time_window_start == other.time_window_start &&
    alternative_resolution_action == other.alternative_resolution_action &&
    can_delete_local_storage == other.can_delete_local_storage &&
    display_name == other.display_name &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 195

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


175
176
177
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 175

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 184

def hash
  [time_window_start, alternative_resolution_action, can_delete_local_storage, display_name, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 228

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



222
223
224
 
# File 'lib/oci/core/models/update_instance_maintenance_event_details.rb', line 222

def to_s
  to_hash.to_s
end