Class: OCI::Adm::Models::VulnerabilityAuditSummary

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

Overview

vulnerability audit summary.

Constant Summary collapse

MAX_OBSERVED_SEVERITY_ENUM =
[
  MAX_OBSERVED_SEVERITY_NONE = 'NONE'.freeze,
  MAX_OBSERVED_SEVERITY_LOW = 'LOW'.freeze,
  MAX_OBSERVED_SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  MAX_OBSERVED_SEVERITY_HIGH = 'HIGH'.freeze,
  MAX_OBSERVED_SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  MAX_OBSERVED_SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MAX_OBSERVED_SEVERITY_WITH_IGNORED_ENUM =
[
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_NONE = 'NONE'.freeze,
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_LOW = 'LOW'.freeze,
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_MEDIUM = 'MEDIUM'.freeze,
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_HIGH = 'HIGH'.freeze,
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_CRITICAL = 'CRITICAL'.freeze,
  MAX_OBSERVED_SEVERITY_WITH_IGNORED_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VulnerabilityAuditSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 198

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

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

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

  self.max_observed_cvss_v3_score = attributes[:'maxObservedCvssV3Score'] if attributes[:'maxObservedCvssV3Score']

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

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

  self.max_observed_severity = attributes[:'maxObservedSeverity'] if attributes[:'maxObservedSeverity']

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

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

  self.vulnerable_artifacts_count = attributes[:'vulnerableArtifactsCount'] if attributes[:'vulnerableArtifactsCount']

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

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

  self.max_observed_cvss_v2_score_with_ignored = attributes[:'maxObservedCvssV2ScoreWithIgnored'] if attributes[:'maxObservedCvssV2ScoreWithIgnored']

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

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

  self.max_observed_cvss_v3_score_with_ignored = attributes[:'maxObservedCvssV3ScoreWithIgnored'] if attributes[:'maxObservedCvssV3ScoreWithIgnored']

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

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

  self.max_observed_severity_with_ignored = attributes[:'maxObservedSeverityWithIgnored'] if attributes[:'maxObservedSeverityWithIgnored']

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

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

  self.vulnerable_artifacts_count_with_ignored = attributes[:'vulnerableArtifactsCountWithIgnored'] if attributes[:'vulnerableArtifactsCountWithIgnored']

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

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

  self.is_success = attributes[:'isSuccess'] unless attributes[:'isSuccess'].nil?

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

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

  self.build_type = attributes[:'buildType'] if attributes[:'buildType']

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

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

#build_typeString

The type of the build tool is restricted to only two values MAVEN or UNSET. Use UNSET when the list of application dependencies is not Maven-related or is a mix of Maven and other ecosystems. This option is soon to be deprecated.

Returns:

  • (String)


92
93
94
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 92

def build_type
  @build_type
end

#compartment_idString

[Required] The compartment Oracle Cloud identifier (OCID) of the vulnerability audit.

Returns:

  • (String)


96
97
98
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 96

def compartment_id
  @compartment_id
end

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


108
109
110
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 108

def defined_tags
  @defined_tags
end

#display_nameString

The name of the vulnerability audit.

Returns:

  • (String)


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

def display_name
  @display_name
end

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


102
103
104
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 102

def freeform_tags
  @freeform_tags
end

#idString

[Required] The Oracle Cloud identifier (OCID) of the vulnerability audit.

Returns:

  • (String)


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

def id
  @id
end

#is_successBOOLEAN

Indicates if an audit succeeded according to the configuration. The value is null if the audit is in the CREATING state.

Returns:

  • (BOOLEAN)


88
89
90
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 88

def is_success
  @is_success
end

#knowledge_base_idString

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

Returns:

  • (String)


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

def knowledge_base_id
  @knowledge_base_id
end

#lifecycle_stateString

[Required] The current lifecycle state of the vulnerability audit.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#max_observed_cvss_v2_scoreFloat

Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.

Returns:

  • (Float)


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

def max_observed_cvss_v2_score
  @max_observed_cvss_v2_score
end

#max_observed_cvss_v2_score_with_ignoredFloat

Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.

Returns:

  • (Float)


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

def max_observed_cvss_v2_score_with_ignored
  @max_observed_cvss_v2_score_with_ignored
end

#max_observed_cvss_v3_scoreFloat

Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.

Returns:

  • (Float)


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

def max_observed_cvss_v3_score
  @max_observed_cvss_v3_score
end

#max_observed_cvss_v3_score_with_ignoredFloat

Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.

Returns:

  • (Float)


76
77
78
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 76

def max_observed_cvss_v3_score_with_ignored
  @max_observed_cvss_v3_score_with_ignored
end

#max_observed_severityString

Maximum ADM Severity observed for non-ignored vulnerable application dependencies.

Returns:

  • (String)


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

def max_observed_severity
  @max_observed_severity
end

#max_observed_severity_with_ignoredString

Maximum ADM Severity observed for vulnerable application dependencies including ignored ones.

Returns:

  • (String)


80
81
82
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 80

def max_observed_severity_with_ignored
  @max_observed_severity_with_ignored
end

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


114
115
116
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 114

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

[Required] The update date and time of the vulnerability audit (formatted according to RFC3339).

Returns:

  • (DateTime)


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

def time_updated
  @time_updated
end

#vulnerable_artifacts_countInteger

[Required] Count of non-ignored vulnerable application dependencies.

Returns:

  • (Integer)


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

def vulnerable_artifacts_count
  @vulnerable_artifacts_count
end

#vulnerable_artifacts_count_with_ignoredInteger

[Required] Count of all vulnerable application dependencies.

Returns:

  • (Integer)


84
85
86
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 84

def vulnerable_artifacts_count_with_ignored
  @vulnerable_artifacts_count_with_ignored
end

Class Method Details

.attribute_mapObject

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'knowledge_base_id': :'knowledgeBaseId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'max_observed_cvss_v2_score': :'maxObservedCvssV2Score',
    'max_observed_cvss_v3_score': :'maxObservedCvssV3Score',
    'max_observed_severity': :'maxObservedSeverity',
    'vulnerable_artifacts_count': :'vulnerableArtifactsCount',
    'max_observed_cvss_v2_score_with_ignored': :'maxObservedCvssV2ScoreWithIgnored',
    'max_observed_cvss_v3_score_with_ignored': :'maxObservedCvssV3ScoreWithIgnored',
    'max_observed_severity_with_ignored': :'maxObservedSeverityWithIgnored',
    'vulnerable_artifacts_count_with_ignored': :'vulnerableArtifactsCountWithIgnored',
    'is_success': :'isSuccess',
    'build_type': :'buildType',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
170
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 145

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'knowledge_base_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'max_observed_cvss_v2_score': :'Float',
    'max_observed_cvss_v3_score': :'Float',
    'max_observed_severity': :'String',
    'vulnerable_artifacts_count': :'Integer',
    'max_observed_cvss_v2_score_with_ignored': :'Float',
    'max_observed_cvss_v3_score_with_ignored': :'Float',
    'max_observed_severity_with_ignored': :'String',
    'vulnerable_artifacts_count_with_ignored': :'Integer',
    'is_success': :'BOOLEAN',
    'build_type': :'String',
    'compartment_id': :'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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 354

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    knowledge_base_id == other.knowledge_base_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    max_observed_cvss_v2_score == other.max_observed_cvss_v2_score &&
    max_observed_cvss_v3_score == other.max_observed_cvss_v3_score &&
    max_observed_severity == other.max_observed_severity &&
    vulnerable_artifacts_count == other.vulnerable_artifacts_count &&
    max_observed_cvss_v2_score_with_ignored == other.max_observed_cvss_v2_score_with_ignored &&
    max_observed_cvss_v3_score_with_ignored == other.max_observed_cvss_v3_score_with_ignored &&
    max_observed_severity_with_ignored == other.max_observed_severity_with_ignored &&
    vulnerable_artifacts_count_with_ignored == other.vulnerable_artifacts_count_with_ignored &&
    is_success == other.is_success &&
    build_type == other.build_type &&
    compartment_id == other.compartment_id &&
    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



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

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


383
384
385
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 383

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



392
393
394
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 392

def hash
  [id, display_name, knowledge_base_id, time_created, time_updated, lifecycle_state, max_observed_cvss_v2_score, max_observed_cvss_v3_score, max_observed_severity, vulnerable_artifacts_count, max_observed_cvss_v2_score_with_ignored, max_observed_cvss_v3_score_with_ignored, max_observed_severity_with_ignored, vulnerable_artifacts_count_with_ignored, is_success, build_type, compartment_id, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



436
437
438
439
440
441
442
443
444
445
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 436

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



430
431
432
# File 'lib/oci/adm/models/vulnerability_audit_summary.rb', line 430

def to_s
  to_hash.to_s
end