Class: OCI::Adm::Models::RemediationRecipe

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/adm/models/remediation_recipe.rb

Overview

An Application Dependency Management (ADM) remediation recipe contains the basic configuration and the details of each of the remediation stages (Detect, Recommend, Verify, and Apply).

Constant Summary collapse

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

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
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/adm/models/remediation_recipe.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.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.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.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.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.knowledge_base_id = attributes[:'knowledgeBaseId'] if attributes[:'knowledgeBaseId']

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

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

  self.is_run_triggered_on_kb_change = attributes[:'isRunTriggeredOnKbChange'] unless attributes[:'isRunTriggeredOnKbChange'].nil?

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

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

  self.scm_configuration = attributes[:'scmConfiguration'] if attributes[:'scmConfiguration']

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

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

  self.verify_configuration = attributes[:'verifyConfiguration'] if attributes[:'verifyConfiguration']

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

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

  self.detect_configuration = attributes[:'detectConfiguration'] if attributes[:'detectConfiguration']

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

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

  self.network_configuration = attributes[:'networkConfiguration'] if attributes[:'networkConfiguration']

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

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

  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] The compartment Oracle Cloud Identifier (OCID) of the remediation recipe.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 48

def compartment_id
  @compartment_id
end

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

[Required] 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/adm/models/remediation_recipe.rb', line 84

def defined_tags
  @defined_tags
end

#detect_configuration ⇒ OCI::Adm::Models::DetectConfiguration

This attribute is required.

Returns:



68
69
70
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 68

def detect_configuration
  @detect_configuration
end

#display_name ⇒ String

[Required] The name of the Remediation Recipe.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 32

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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/adm/models/remediation_recipe.rb', line 78

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The Oracle Cloud Identifier (OCID) of the remediation recipe.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 28

def id
  @id
end

#is_run_triggered_on_kb_change ⇒ BOOLEAN

[Required] Boolean indicating if a run should be automatically triggered once the Knowledge Base contents are updated.

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 56

def is_run_triggered_on_kb_change
  @is_run_triggered_on_kb_change
end

#knowledge_base_id ⇒ String

[Required] The Oracle Cloud Identifier (OCID) of the knowledge base.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 52

def knowledge_base_id
  @knowledge_base_id
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the Remediation Recipe.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#network_configuration ⇒ OCI::Adm::Models::NetworkConfiguration

This attribute is required.

Returns:



72
73
74
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 72

def network_configuration
  @network_configuration
end

#scm_configuration ⇒ OCI::Adm::Models::ScmConfiguration

This attribute is required.

Returns:



60
61
62
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 60

def scm_configuration
  @scm_configuration
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


90
91
92
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 90

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The creation date and time of the Remediation Recipe (formatted according to RFC3339).

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 36

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the Remediation Recipe was last updated (formatted according to RFC3339).

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 40

def time_updated
  @time_updated
end

#verify_configuration ⇒ OCI::Adm::Models::VerifyConfiguration

This attribute is required.

Returns:



64
65
66
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 64

def verify_configuration
  @verify_configuration
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/adm/models/remediation_recipe.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'compartment_id': :'compartmentId',
    'knowledge_base_id': :'knowledgeBaseId',
    'is_run_triggered_on_kb_change': :'isRunTriggeredOnKbChange',
    'scm_configuration': :'scmConfiguration',
    'verify_configuration': :'verifyConfiguration',
    'detect_configuration': :'detectConfiguration',
    'network_configuration': :'networkConfiguration',
    '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/adm/models/remediation_recipe.rb', line 116

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'compartment_id': :'String',
    'knowledge_base_id': :'String',
    'is_run_triggered_on_kb_change': :'BOOLEAN',
    'scm_configuration': :'OCI::Adm::Models::ScmConfiguration',
    'verify_configuration': :'OCI::Adm::Models::VerifyConfiguration',
    'detect_configuration': :'OCI::Adm::Models::DetectConfiguration',
    'network_configuration': :'OCI::Adm::Models::NetworkConfiguration',
    '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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 272

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    compartment_id == other.compartment_id &&
    knowledge_base_id == other.knowledge_base_id &&
    is_run_triggered_on_kb_change == other.is_run_triggered_on_kb_change &&
    scm_configuration == other.scm_configuration &&
    verify_configuration == other.verify_configuration &&
    detect_configuration == other.detect_configuration &&
    network_configuration == other.network_configuration &&
    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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 316

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


296
297
298
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 296

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 305

def hash
  [id, display_name, time_created, time_updated, lifecycle_state, compartment_id, knowledge_base_id, is_run_triggered_on_kb_change, scm_configuration, verify_configuration, detect_configuration, network_configuration, 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



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 349

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



343
344
345
 
# File 'lib/oci/adm/models/remediation_recipe.rb', line 343

def to_s
  to_hash.to_s
end