Class: OCI::Database::Models::ScheduledActionSummary

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

Overview

Details of a scheduled action.

Constant Summary collapse

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_FSU_VM_CLUSTER_OS_SOFTWARE_UPDATE = 'FSU_VM_CLUSTER_OS_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_FSU_VM_CLUSTER_GI_SOFTWARE_UPDATE = 'FSU_VM_CLUSTER_GI_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_FSU_VM_CLUSTER_GI_OS_SOFTWARE_UPDATE = 'FSU_VM_CLUSTER_GI_OS_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_DB_SERVER_ONLINE_SOFTWARE_UPDATE = 'DB_SERVER_ONLINE_SOFTWARE_UPDATE'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledActionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :scheduling_plan_id (String) —

    The value to assign to the #scheduling_plan_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :scheduling_window_id (String) —

    The value to assign to the #scheduling_window_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :action_order (Integer) —

    The value to assign to the #action_order property

  • :action_type (String) —

    The value to assign to the #action_type property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :estimated_time_in_mins (Integer) —

    The value to assign to the #estimated_time_in_mins property

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

    The value to assign to the #action_params property

  • :action_members (Array<OCI::Database::Models::ActionMember>) —

    The value to assign to the #action_members property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 179

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

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

  self.scheduling_plan_id = attributes[:'scheduling_plan_id'] if attributes[:'scheduling_plan_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.scheduling_window_id = attributes[:'schedulingWindowId'] if attributes[:'schedulingWindowId']

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

  self.scheduling_window_id = attributes[:'scheduling_window_id'] if attributes[:'scheduling_window_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.action_order = attributes[:'actionOrder'] if attributes[:'actionOrder']

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

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

  self.action_type = attributes[:'actionType'] if attributes[:'actionType']
  self.action_type = "DB_SERVER_FULL_SOFTWARE_UPDATE" if action_type.nil? && !attributes.key?(:'actionType') # rubocop:disable Style/StringLiterals

  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_type = "DB_SERVER_FULL_SOFTWARE_UPDATE" if action_type.nil? && !attributes.key?(:'actionType') && !attributes.key?(:'action_type') # rubocop:disable Style/StringLiterals

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

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

Instance Attribute Details

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

The list of action members in a scheduled action.

Returns:



79
80
81
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 79

def action_members
  @action_members
end

#action_order ⇒ Integer

[Required] The order of the scheduled action.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 56

def action_order
  @action_order
end

#action_params ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


75
76
77
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 75

def action_params
  @action_params
end

#action_type ⇒ String

[Required] The type of the scheduled action being performed

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 60

def action_type
  @action_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 44

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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The display name of the Scheduled Action.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 52

def display_name
  @display_name
end

#estimated_time_in_mins ⇒ Integer

The estimated patching time for the scheduled action.

Returns:

  • (Integer) 


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

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


87
88
89
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 87

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Scheduled Action.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 36

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Scheduled Action. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#scheduling_plan_id ⇒ String

[Required] The OCID of the Scheduling Plan.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 40

def scheduling_plan_id
  @scheduling_plan_id
end

#scheduling_window_id ⇒ String

The OCID of the Scheduling Window.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 48

def scheduling_window_id
  @scheduling_window_id
end

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

System 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>>) 


99
100
101
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 99

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Scheduled Action Resource was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Scheduled Action Resource was updated.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'scheduling_plan_id': :'schedulingPlanId',
    'compartment_id': :'compartmentId',
    'scheduling_window_id': :'schedulingWindowId',
    'display_name': :'displayName',
    'action_order': :'actionOrder',
    'action_type': :'actionType',
    'lifecycle_state': :'lifecycleState',
    'estimated_time_in_mins': :'estimatedTimeInMins',
    'action_params': :'actionParams',
    'action_members': :'actionMembers',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 134

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'scheduling_plan_id': :'String',
    'compartment_id': :'String',
    'scheduling_window_id': :'String',
    'display_name': :'String',
    'action_order': :'Integer',
    'action_type': :'String',
    'lifecycle_state': :'String',
    'estimated_time_in_mins': :'Integer',
    'action_params': :'Hash<String, String>',
    'action_members': :'Array<OCI::Database::Models::ActionMember>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 313

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

  self.class == other.class &&
    id == other.id &&
    scheduling_plan_id == other.scheduling_plan_id &&
    compartment_id == other.compartment_id &&
    scheduling_window_id == other.scheduling_window_id &&
    display_name == other.display_name &&
    action_order == other.action_order &&
    action_type == other.action_type &&
    lifecycle_state == other.lifecycle_state &&
    estimated_time_in_mins == other.estimated_time_in_mins &&
    action_params == other.action_params &&
    action_members == other.action_members &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 358

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


338
339
340
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 338

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



347
348
349
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 347

def hash
  [id, scheduling_plan_id, compartment_id, scheduling_window_id, display_name, action_order, action_type, lifecycle_state, estimated_time_in_mins, action_params, action_members, freeform_tags, defined_tags, system_tags, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



391
392
393
394
395
396
397
398
399
400
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 391

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



385
386
387
 
# File 'lib/oci/database/models/scheduled_action_summary.rb', line 385

def to_s
  to_hash.to_s
end