Class: OCI::Adm::Models::RemediationRun
- Inherits:
-
Object
- Object
- OCI::Adm::Models::RemediationRun
- Defined in:
- lib/oci/adm/models/remediation_run.rb
Overview
A remediation run represents an execution of a Remediation Recipe to detect and fix vulnerabilities based on current state of the Vulnerabilities curated in the Knowledge Base. A Run can be triggered manually or when a new CVE is discovered.
Constant Summary collapse
- REMEDIATION_RUN_SOURCE_ENUM =
[ REMEDIATION_RUN_SOURCE_MANUAL = 'MANUAL'.freeze, REMEDIATION_RUN_SOURCE_KNOWLEDGE_BASE = 'KNOWLEDGE_BASE'.freeze, REMEDIATION_RUN_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- CURRENT_STAGE_TYPE_ENUM =
[ CURRENT_STAGE_TYPE_DETECT = 'DETECT'.freeze, CURRENT_STAGE_TYPE_RECOMMEND = 'RECOMMEND'.freeze, CURRENT_STAGE_TYPE_VERIFY = 'VERIFY'.freeze, CURRENT_STAGE_TYPE_APPLY = 'APPLY'.freeze, CURRENT_STAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze, LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze, LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze, LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.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
-
#compartment_id ⇒ String
[Required] The compartment Oracle Cloud Identifier (OCID) of the remediation run.
-
#current_stage_type ⇒ String
The type of the current stage of the remediation run.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource.
-
#display_name ⇒ String
The name of the remediation run.
-
#freeform_tags ⇒ Hash<String, String>
[Required] Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The Oracle Cloud Identifier (OCID) of the remediation run.
-
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the remediation run.
-
#remediation_recipe_id ⇒ String
[Required] The Oracle Cloud Identifier (OCID) of the Remediation Recipe.
-
#remediation_run_source ⇒ String
[Required] The source that triggered the Remediation Recipe.
-
#stages ⇒ Array<OCI::Adm::Models::StageSummary>
The list of remediation run stage summaries.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The creation date and time of the remediation run (formatted according to RFC3339).
-
#time_finished ⇒ DateTime
The date and time of the finish of the remediation run (formatted according to RFC3339).
-
#time_started ⇒ DateTime
The date and time of the start of the remediation run (formatted according to RFC3339).
-
#time_updated ⇒ DateTime
[Required] The date and time the remediation run was last updated (formatted according to RFC3339).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RemediationRun
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ RemediationRun
Initializes the object
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 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/oci/adm/models/remediation_run.rb', line 174 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.stages = attributes[:'stages'] if attributes[:'stages'] self.remediation_recipe_id = attributes[:'remediationRecipeId'] if attributes[:'remediationRecipeId'] raise 'You cannot provide both :remediationRecipeId and :remediation_recipe_id' if attributes.key?(:'remediationRecipeId') && attributes.key?(:'remediation_recipe_id') self.remediation_recipe_id = attributes[:'remediation_recipe_id'] if attributes[:'remediation_recipe_id'] self.remediation_run_source = attributes[:'remediationRunSource'] if attributes[:'remediationRunSource'] raise 'You cannot provide both :remediationRunSource and :remediation_run_source' if attributes.key?(:'remediationRunSource') && attributes.key?(:'remediation_run_source') self.remediation_run_source = attributes[:'remediation_run_source'] if attributes[:'remediation_run_source'] 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.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted'] raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started') self.time_started = attributes[:'time_started'] if attributes[:'time_started'] self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished'] raise 'You cannot provide both :timeFinished and :time_finished' if attributes.key?(:'timeFinished') && attributes.key?(:'time_finished') self.time_finished = attributes[:'time_finished'] if attributes[:'time_finished'] self.current_stage_type = attributes[:'currentStageType'] if attributes[:'currentStageType'] raise 'You cannot provide both :currentStageType and :current_stage_type' if attributes.key?(:'currentStageType') && attributes.key?(:'current_stage_type') self.current_stage_type = attributes[:'current_stage_type'] if attributes[:'current_stage_type'] 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The compartment Oracle Cloud Identifier (OCID) of the remediation run.
83 84 85 |
# File 'lib/oci/adm/models/remediation_run.rb', line 83 def compartment_id @compartment_id end |
#current_stage_type ⇒ String
The type of the current stage of the remediation run.
79 80 81 |
# File 'lib/oci/adm/models/remediation_run.rb', line 79 def current_stage_type @current_stage_type 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\"}}
99 100 101 |
# File 'lib/oci/adm/models/remediation_run.rb', line 99 def @defined_tags end |
#display_name ⇒ String
The name of the remediation run.
47 48 49 |
# File 'lib/oci/adm/models/remediation_run.rb', line 47 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\"}
93 94 95 |
# File 'lib/oci/adm/models/remediation_run.rb', line 93 def @freeform_tags end |
#id ⇒ String
[Required] The Oracle Cloud Identifier (OCID) of the remediation run.
43 44 45 |
# File 'lib/oci/adm/models/remediation_run.rb', line 43 def id @id end |
#lifecycle_state ⇒ String
[Required] The current lifecycle state of the remediation run.
87 88 89 |
# File 'lib/oci/adm/models/remediation_run.rb', line 87 def lifecycle_state @lifecycle_state end |
#remediation_recipe_id ⇒ String
[Required] The Oracle Cloud Identifier (OCID) of the Remediation Recipe.
55 56 57 |
# File 'lib/oci/adm/models/remediation_run.rb', line 55 def remediation_recipe_id @remediation_recipe_id end |
#remediation_run_source ⇒ String
[Required] The source that triggered the Remediation Recipe.
59 60 61 |
# File 'lib/oci/adm/models/remediation_run.rb', line 59 def remediation_run_source @remediation_run_source end |
#stages ⇒ Array<OCI::Adm::Models::StageSummary>
The list of remediation run stage summaries.
51 52 53 |
# File 'lib/oci/adm/models/remediation_run.rb', line 51 def stages @stages 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\"}}
105 106 107 |
# File 'lib/oci/adm/models/remediation_run.rb', line 105 def @system_tags end |
#time_created ⇒ DateTime
[Required] The creation date and time of the remediation run (formatted according to RFC3339).
63 64 65 |
# File 'lib/oci/adm/models/remediation_run.rb', line 63 def time_created @time_created end |
#time_finished ⇒ DateTime
The date and time of the finish of the remediation run (formatted according to RFC3339).
75 76 77 |
# File 'lib/oci/adm/models/remediation_run.rb', line 75 def time_finished @time_finished end |
#time_started ⇒ DateTime
The date and time of the start of the remediation run (formatted according to RFC3339).
71 72 73 |
# File 'lib/oci/adm/models/remediation_run.rb', line 71 def time_started @time_started end |
#time_updated ⇒ DateTime
[Required] The date and time the remediation run was last updated (formatted according to RFC3339).
67 68 69 |
# File 'lib/oci/adm/models/remediation_run.rb', line 67 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/oci/adm/models/remediation_run.rb', line 108 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'stages': :'stages', 'remediation_recipe_id': :'remediationRecipeId', 'remediation_run_source': :'remediationRunSource', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'time_started': :'timeStarted', 'time_finished': :'timeFinished', 'current_stage_type': :'currentStageType', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/oci/adm/models/remediation_run.rb', line 131 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'stages': :'Array<OCI::Adm::Models::StageSummary>', 'remediation_recipe_id': :'String', 'remediation_run_source': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'time_started': :'DateTime', 'time_finished': :'DateTime', 'current_stage_type': :'String', 'compartment_id': :'String', 'lifecycle_state': :'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.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/oci/adm/models/remediation_run.rb', line 309 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && stages == other.stages && remediation_recipe_id == other.remediation_recipe_id && remediation_run_source == other.remediation_run_source && time_created == other.time_created && time_updated == other.time_updated && time_started == other.time_started && time_finished == other.time_finished && current_stage_type == other.current_stage_type && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/oci/adm/models/remediation_run.rb', line 353 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
333 334 335 |
# File 'lib/oci/adm/models/remediation_run.rb', line 333 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
342 343 344 |
# File 'lib/oci/adm/models/remediation_run.rb', line 342 def hash [id, display_name, stages, remediation_recipe_id, remediation_run_source, time_created, time_updated, time_started, time_finished, current_stage_type, compartment_id, lifecycle_state, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
386 387 388 389 390 391 392 393 394 395 |
# File 'lib/oci/adm/models/remediation_run.rb', line 386 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
380 381 382 |
# File 'lib/oci/adm/models/remediation_run.rb', line 380 def to_s to_hash.to_s end |