Class: OCI::FleetAppsManagement::Models::Runbook

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

Overview

Runbook definition. Runbooks allow you to capture procedural tasks for handling a workflow. Only active versions of runbook will be available for executions.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_USER_DEFINED = 'USER_DEFINED'.freeze,
  TYPE_ORACLE_DEFINED = 'ORACLE_DEFINED'.freeze,
  TYPE_SYSTEM_DEFINED = 'SYSTEM_DEFINED'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OS_TYPE_ENUM = 
[
  OS_TYPE_WINDOWS = 'WINDOWS'.freeze,
  OS_TYPE_LINUX = 'LINUX'.freeze,
  OS_TYPE_GENERIC = 'GENERIC'.freeze,
  OS_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ Runbook

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :type (String) —

    The value to assign to the #type property

  • :operation (String) —

    The value to assign to the #operation property

  • :os_type (String) —

    The value to assign to the #os_type property

  • :platform (String) —

    The value to assign to the #platform property

  • :is_default (BOOLEAN) —

    The value to assign to the #is_default property

  • :is_sudo_access_needed (BOOLEAN) —

    The value to assign to the #is_sudo_access_needed property

  • :estimated_time (String) —

    The value to assign to the #estimated_time property

  • :latest_version (String) —

    The value to assign to the #latest_version property

  • :has_draft_version (BOOLEAN) —

    The value to assign to the #has_draft_version property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details 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

  • :runbook_version (OCI::FleetAppsManagement::Models::Version) —

    The value to assign to the #runbook_version property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :resource_region (String) —

    The value to assign to the #resource_region 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



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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 229

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

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

  self.os_type = attributes[:'osType'] if attributes[:'osType']

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

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

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

  self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') # rubocop:disable Style/StringLiterals

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

  self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') && !attributes.key?(:'is_default') # rubocop:disable Style/StringLiterals

  self.is_sudo_access_needed = attributes[:'isSudoAccessNeeded'] unless attributes[:'isSudoAccessNeeded'].nil?
  self.is_sudo_access_needed = false if is_sudo_access_needed.nil? && !attributes.key?(:'isSudoAccessNeeded') # rubocop:disable Style/StringLiterals

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

  self.is_sudo_access_needed = attributes[:'is_sudo_access_needed'] unless attributes[:'is_sudo_access_needed'].nil?
  self.is_sudo_access_needed = false if is_sudo_access_needed.nil? && !attributes.key?(:'isSudoAccessNeeded') && !attributes.key?(:'is_sudo_access_needed') # rubocop:disable Style/StringLiterals

  self.estimated_time = attributes[:'estimatedTime'] if attributes[:'estimatedTime']

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

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

  self.latest_version = attributes[:'latestVersion'] if attributes[:'latestVersion']

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

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

  self.has_draft_version = attributes[:'hasDraftVersion'] unless attributes[:'hasDraftVersion'].nil?
  self.has_draft_version = false if has_draft_version.nil? && !attributes.key?(:'hasDraftVersion') # rubocop:disable Style/StringLiterals

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

  self.has_draft_version = attributes[:'has_draft_version'] unless attributes[:'has_draft_version'].nil?
  self.has_draft_version = false if has_draft_version.nil? && !attributes.key?(:'hasDraftVersion') && !attributes.key?(:'has_draft_version') # 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.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.runbook_version = attributes[:'runbookVersion'] if attributes[:'runbookVersion']

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

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

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

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

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

  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

[Required] OCID of the compartment to which the resource belongs to.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 117

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


133
134
135
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 133

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Example: My new resource

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 50

def display_name
  @display_name
end

#estimated_time ⇒ String

Estimated time to successfully complete the runbook execution.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 86

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


127
128
129
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 127

def freeform_tags
  @freeform_tags
end

#has_draft_version ⇒ BOOLEAN

Does this runbook has draft versions?

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 94

def has_draft_version
  @has_draft_version
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 42

def id
  @id
end

#is_default ⇒ BOOLEAN

[Required] Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.

Returns:

  • (BOOLEAN) 


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

def is_default
  @is_default
end

#is_sudo_access_needed ⇒ BOOLEAN

Does this runbook need SUDO access to execute?

Returns:

  • (BOOLEAN) 


82
83
84
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 82

def is_sudo_access_needed
  @is_sudo_access_needed
end

#latest_version ⇒ String

Latest runbook version

Returns:

  • (String) 


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

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


102
103
104
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 102

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the runbook.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 98

def lifecycle_state
  @lifecycle_state
end

#operation ⇒ String

[Required] The lifecycle operation performed by the runbook.

Returns:

  • (String) 


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

def operation
  @operation
end

#os_type ⇒ String

The OS type for the runbook.

Returns:

  • (String) 


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

def os_type
  @os_type
end

#platform ⇒ String

The platform of the runbook.

Returns:

  • (String) 


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

def platform
  @platform
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 121

def resource_region
  @resource_region
end

#runbook_version ⇒ OCI::FleetAppsManagement::Models::Version

Returns:



113
114
115
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 113

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


139
140
141
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 139

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


106
107
108
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 106

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


110
111
112
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 110

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the runbook.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 142

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'operation': :'operation',
    'os_type': :'osType',
    'platform': :'platform',
    'is_default': :'isDefault',
    'is_sudo_access_needed': :'isSudoAccessNeeded',
    'estimated_time': :'estimatedTime',
    'latest_version': :'latestVersion',
    'has_draft_version': :'hasDraftVersion',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'runbook_version': :'runbookVersion',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 172

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'type': :'String',
    'operation': :'String',
    'os_type': :'String',
    'platform': :'String',
    'is_default': :'BOOLEAN',
    'is_sudo_access_needed': :'BOOLEAN',
    'estimated_time': :'String',
    'latest_version': :'String',
    'has_draft_version': :'BOOLEAN',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'runbook_version': :'OCI::FleetAppsManagement::Models::Version',
    'compartment_id': :'String',
    'resource_region': :'String',
    '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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 400

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    operation == other.operation &&
    os_type == other.os_type &&
    platform == other.platform &&
    is_default == other.is_default &&
    is_sudo_access_needed == other.is_sudo_access_needed &&
    estimated_time == other.estimated_time &&
    latest_version == other.latest_version &&
    has_draft_version == other.has_draft_version &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    runbook_version == other.runbook_version &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 451

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


431
432
433
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 431

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



440
441
442
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 440

def hash
  [id, display_name, description, type, operation, os_type, platform, is_default, is_sudo_access_needed, estimated_time, latest_version, has_draft_version, lifecycle_state, lifecycle_details, time_created, time_updated, runbook_version, compartment_id, resource_region, 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



484
485
486
487
488
489
490
491
492
493
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 484

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



478
479
480
 
# File 'lib/oci/fleet_apps_management/models/runbook.rb', line 478

def to_s
  to_hash.to_s
end