Class: OCI::FleetAppsManagement::Models::RunbookVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/runbook_version.rb

Overview

Version for the runbook. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ RunbookVersion

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 159

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

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

  self.runbook_id = attributes[:'runbook_id'] if attributes[:'runbook_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.tasks = attributes[:'tasks'] if attributes[:'tasks']

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

  self.execution_workflow_details = attributes[:'executionWorkflowDetails'] if attributes[:'executionWorkflowDetails']

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

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

  self.rollback_workflow_details = attributes[:'rollbackWorkflowDetails'] if attributes[:'rollbackWorkflowDetails']

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

OCID of the compartment to which the resource belongs to.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 36

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


84
85
86
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 84

def defined_tags
  @defined_tags
end

#execution_workflow_details ⇒ OCI::FleetAppsManagement::Models::ExecutionWorkflowDetails

This attribute is required.

Returns:



49
50
51
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 49

def execution_workflow_details
  @execution_workflow_details
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


78
79
80
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 78

def freeform_tags
  @freeform_tags
end

#groups ⇒ Array<OCI::FleetAppsManagement::Models::Group>

[Required] The groups of the runbook.

Returns:



45
46
47
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 45

def groups
  @groups
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 28

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 64

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the runbook version.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The version of the runbook.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 56

def name
  @name
end

#rollback_workflow_details ⇒ OCI::FleetAppsManagement::Models::RollbackWorkflowDetails

Returns:



52
53
54
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 52

def rollback_workflow_details
  @rollback_workflow_details
end

#runbook_id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 32

def runbook_id
  @runbook_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


90
91
92
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 90

def system_tags
  @system_tags
end

#tasks ⇒ Array<OCI::FleetAppsManagement::Models::Task>

[Required] A set of tasks to execute in the runbook.

Returns:



40
41
42
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 40

def tasks
  @tasks
end

#time_created ⇒ DateTime

The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 68

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 72

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'runbook_id': :'runbookId',
    'compartment_id': :'compartmentId',
    'tasks': :'tasks',
    'groups': :'groups',
    'execution_workflow_details': :'executionWorkflowDetails',
    'rollback_workflow_details': :'rollbackWorkflowDetails',
    'name': :'name',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 116

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'runbook_id': :'String',
    'compartment_id': :'String',
    'tasks': :'Array<OCI::FleetAppsManagement::Models::Task>',
    'groups': :'Array<OCI::FleetAppsManagement::Models::Group>',
    'execution_workflow_details': :'OCI::FleetAppsManagement::Models::ExecutionWorkflowDetails',
    'rollback_workflow_details': :'OCI::FleetAppsManagement::Models::RollbackWorkflowDetails',
    'name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 260

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

  self.class == other.class &&
    id == other.id &&
    runbook_id == other.runbook_id &&
    compartment_id == other.compartment_id &&
    tasks == other.tasks &&
    groups == other.groups &&
    execution_workflow_details == other.execution_workflow_details &&
    rollback_workflow_details == other.rollback_workflow_details &&
    name == other.name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 304

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


284
285
286
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 284

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



293
294
295
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 293

def hash
  [id, runbook_id, compartment_id, tasks, groups, execution_workflow_details, rollback_workflow_details, name, lifecycle_state, lifecycle_details, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 337

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



331
332
333
 
# File 'lib/oci/fleet_apps_management/models/runbook_version.rb', line 331

def to_s
  to_hash.to_s
end