Class: OCI::Database::Models::ExecutionActionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/execution_action_summary.rb

Overview

Details of an execution action.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_SCHEDULED = 'SCHEDULED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_PARTIAL_SUCCESS = 'PARTIAL_SUCCESS'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_SUBSTATE_ENUM = 
[
  LIFECYCLE_SUBSTATE_DURATION_EXCEEDED = 'DURATION_EXCEEDED'.freeze,
  LIFECYCLE_SUBSTATE_MAINTENANCE_IN_PROGRESS = 'MAINTENANCE_IN_PROGRESS'.freeze,
  LIFECYCLE_SUBSTATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_SUBSTATE_RESCHEDULED = 'RESCHEDULED'.freeze,
  LIFECYCLE_SUBSTATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ACTION_TYPE_ENUM = 
[
  ACTION_TYPE_DB_SERVER_FULL_SOFTWARE_UPDATE = 'DB_SERVER_FULL_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_STORAGE_SERVER_FULL_SOFTWARE_UPDATE = 'STORAGE_SERVER_FULL_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_NETWORK_SWITCH_FULL_SOFTWARE_UPDATE = 'NETWORK_SWITCH_FULL_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExecutionActionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 199

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.id = attributes[:'id'] if attributes[:'id']

  self.execution_window_id = attributes[:'executionWindowId'] if attributes[:'executionWindowId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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.description = attributes[:'description'] if attributes[:'description']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_substate = attributes[:'lifecycleSubstate'] if attributes[:'lifecycleSubstate']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.estimated_time_in_mins = attributes[:'estimatedTimeInMins'] if attributes[:'estimatedTimeInMins']

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

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

  self.total_time_taken_in_mins = attributes[:'totalTimeTakenInMins'] if attributes[:'totalTimeTakenInMins']

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

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

  self.execution_action_order = attributes[:'executionActionOrder'] if attributes[:'executionActionOrder']

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

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

  self.action_type = attributes[:'actionType'] if attributes[:'actionType']

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

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

  self.action_params = attributes[:'actionParams'] if attributes[:'actionParams']

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

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

  self.action_members = attributes[:'actionMembers'] if attributes[:'actionMembers']

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

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

  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']

  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']
end

Instance Attribute Details

#action_members ⇒ Array<OCI::Database::Models::ExecutionActionMember>

List of action members of this execution action.

Returns:



107
108
109
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 107

def action_members
  @action_members
end

#action_params ⇒ Hash<String, String>

[Required] Map<ParamName, ParamValue> where a key value pair describes the specific action parameter. Example: {\"count\": \"3\"}

Returns:

  • (Hash<String, String>) 


103
104
105
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 103

def action_params
  @action_params
end

#action_type ⇒ String

[Required] The action type of the execution action being performed

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 97

def action_type
  @action_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 50

def compartment_id
  @compartment_id
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.

Returns:

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


121
122
123
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 121

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the execution action.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 58

def description
  @description
end

#display_name ⇒ String

[Required] The user-friendly name for the execution action. The name does not need to be unique.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 54

def display_name
  @display_name
end

#estimated_time_in_mins ⇒ Integer

The estimated time of the execution action in minutes.

Returns:

  • (Integer) 


85
86
87
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 85

def estimated_time_in_mins
  @estimated_time_in_mins
end

#execution_action_order ⇒ Integer

The priority order of the execution action.

Returns:

  • (Integer) 


93
94
95
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 93

def execution_action_order
  @execution_action_order
end

#execution_window_id ⇒ String

[Required] The OCID of the execution window resource the execution action belongs to.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 46

def execution_window_id
  @execution_window_id
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>) 


115
116
117
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 115

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the execution action.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 42

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the execution action. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#lifecycle_substate ⇒ String

The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 69

def lifecycle_substate
  @lifecycle_substate
end

#time_created ⇒ DateTime

The date and time the execution action was created.

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 77

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The last date and time that the execution action was updated.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 81

def time_updated
  @time_updated
end

#total_time_taken_in_mins ⇒ Integer

The total time taken by corresponding resource activity in minutes.

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 89

def total_time_taken_in_mins
  @total_time_taken_in_mins
end

Class Method Details

.attribute_map ⇒ Object

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 124

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'execution_window_id': :'executionWindowId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_substate': :'lifecycleSubstate',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'estimated_time_in_mins': :'estimatedTimeInMins',
    'total_time_taken_in_mins': :'totalTimeTakenInMins',
    'execution_action_order': :'executionActionOrder',
    'action_type': :'actionType',
    'action_params': :'actionParams',
    'action_members': :'actionMembers',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 150

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'execution_window_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_substate': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'estimated_time_in_mins': :'Integer',
    'total_time_taken_in_mins': :'Integer',
    'execution_action_order': :'Integer',
    'action_type': :'String',
    'action_params': :'Hash<String, String>',
    'action_members': :'Array<OCI::Database::Models::ExecutionActionMember>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 352

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

  self.class == other.class &&
    id == other.id &&
    execution_window_id == other.execution_window_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_substate == other.lifecycle_substate &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    estimated_time_in_mins == other.estimated_time_in_mins &&
    total_time_taken_in_mins == other.total_time_taken_in_mins &&
    execution_action_order == other.execution_action_order &&
    action_type == other.action_type &&
    action_params == other.action_params &&
    action_members == other.action_members &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 399

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


379
380
381
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 379

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



388
389
390
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 388

def hash
  [id, execution_window_id, compartment_id, display_name, description, lifecycle_state, lifecycle_substate, lifecycle_details, time_created, time_updated, estimated_time_in_mins, total_time_taken_in_mins, execution_action_order, action_type, action_params, action_members, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 432

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



426
427
428
 
# File 'lib/oci/database/models/execution_action_summary.rb', line 426

def to_s
  to_hash.to_s
end