Class: OCI::CloudGuard::Models::SightingSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/sighting_summary.rb

Overview

Sighting summary definition.

Constant Summary collapse

CLASSIFICATION_STATUS_ENUM = 
[
  CLASSIFICATION_STATUS_FALSE_NEGATIVE = 'FALSE_NEGATIVE'.freeze,
  CLASSIFICATION_STATUS_TRUE_NEGATIVE = 'TRUE_NEGATIVE'.freeze,
  CLASSIFICATION_STATUS_FALSE_POSITIVE = 'FALSE_POSITIVE'.freeze,
  CLASSIFICATION_STATUS_TRUE_POSITIVE = 'TRUE_POSITIVE'.freeze,
  CLASSIFICATION_STATUS_NOT_CLASSIFIED = 'NOT_CLASSIFIED'.freeze,
  CLASSIFICATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SEVERITY_ENUM = 
[
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_HIGH = 'HIGH'.freeze,
  SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SEVERITY_LOW = 'LOW'.freeze,
  SEVERITY_MINOR = 'MINOR'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONFIDENCE_ENUM = 
[
  CONFIDENCE_CRITICAL = 'CRITICAL'.freeze,
  CONFIDENCE_HIGH = 'HIGH'.freeze,
  CONFIDENCE_MEDIUM = 'MEDIUM'.freeze,
  CONFIDENCE_LOW = 'LOW'.freeze,
  CONFIDENCE_MINOR = 'MINOR'.freeze,
  CONFIDENCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SightingSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :problem_id (String) —

    The value to assign to the #problem_id property

  • :actor_principal_id (String) —

    The value to assign to the #actor_principal_id property

  • :actor_principal_name (String) —

    The value to assign to the #actor_principal_name property

  • :actor_principal_type (String) —

    The value to assign to the #actor_principal_type property

  • :detector_rule_id (String) —

    The value to assign to the #detector_rule_id property

  • :classification_status (String) —

    The value to assign to the #classification_status property

  • :sighting_type (String) —

    The value to assign to the #sighting_type property

  • :sighting_type_display_name (String) —

    The value to assign to the #sighting_type_display_name property

  • :tactic_name (String) —

    The value to assign to the #tactic_name property

  • :technique_name (String) —

    The value to assign to the #technique_name property

  • :sighting_score (Integer) —

    The value to assign to the #sighting_score property

  • :severity (String) —

    The value to assign to the #severity property

  • :confidence (String) —

    The value to assign to the #confidence property

  • :time_first_detected (DateTime) —

    The value to assign to the #time_first_detected property

  • :time_last_detected (DateTime) —

    The value to assign to the #time_last_detected property

  • :regions (Array<String>) —

    The value to assign to the #regions property



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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 187

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

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

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

  self.actor_principal_id = attributes[:'actorPrincipalId'] if attributes[:'actorPrincipalId']

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

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

  self.actor_principal_name = attributes[:'actorPrincipalName'] if attributes[:'actorPrincipalName']

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

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

  self.actor_principal_type = attributes[:'actorPrincipalType'] if attributes[:'actorPrincipalType']

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

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

  self.detector_rule_id = attributes[:'detectorRuleId'] if attributes[:'detectorRuleId']

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

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

  self.classification_status = attributes[:'classificationStatus'] if attributes[:'classificationStatus']

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

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

  self.sighting_type = attributes[:'sightingType'] if attributes[:'sightingType']

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

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

  self.sighting_type_display_name = attributes[:'sightingTypeDisplayName'] if attributes[:'sightingTypeDisplayName']

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

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

  self.tactic_name = attributes[:'tacticName'] if attributes[:'tacticName']

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

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

  self.technique_name = attributes[:'techniqueName'] if attributes[:'techniqueName']

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

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

  self.sighting_score = attributes[:'sightingScore'] if attributes[:'sightingScore']

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

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

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

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

  self.time_first_detected = attributes[:'timeFirstDetected'] if attributes[:'timeFirstDetected']

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

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

  self.time_last_detected = attributes[:'timeLastDetected'] if attributes[:'timeLastDetected']

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

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

  self.regions = attributes[:'regions'] if attributes[:'regions']
end

Instance Attribute Details

#actor_principal_id ⇒ String

Unique identifier for principal actor

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 53

def actor_principal_id
  @actor_principal_id
end

#actor_principal_name ⇒ String

Name of principal actor

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 57

def actor_principal_name
  @actor_principal_name
end

#actor_principal_type ⇒ String

Type of principal actor

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 61

def actor_principal_type
  @actor_principal_type
end

#classification_status ⇒ String

[Required] Classification status of the sighting

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 69

def classification_status
  @classification_status
end

#compartment_id ⇒ String

[Required] Compartment OCID where the impacted resource is created

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 45

def compartment_id
  @compartment_id
end

#confidence ⇒ String

[Required] Confidence level that the sighting is not a false positive

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 97

def confidence
  @confidence
end

#detector_rule_id ⇒ String

[Required] Unique identifier of the detector rule that was triggered

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 65

def detector_rule_id
  @detector_rule_id
end

#id ⇒ String

[Required] Unique identifier for sighting

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 41

def id
  @id
end

#problem_id ⇒ String

Problem ID associated with sighting

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 49

def problem_id
  @problem_id
end

#regions ⇒ Array<String>

[Required] List of regions involved in the sighting

Returns:

  • (Array<String>) 


109
110
111
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 109

def regions
  @regions
end

#severity ⇒ String

[Required] Severity of the sighting

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 93

def severity
  @severity
end

#sighting_score ⇒ Integer

[Required] Score for the sighting

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 89

def sighting_score
  @sighting_score
end

#sighting_type ⇒ String

[Required] Type of sighting

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 73

def sighting_type
  @sighting_type
end

#sighting_type_display_name ⇒ String

[Required] Display name of the sighting type

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 77

def sighting_type_display_name
  @sighting_type_display_name
end

#tactic_name ⇒ String

[Required] Name of the MITRE ATT@CK framework tactic

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 81

def tactic_name
  @tactic_name
end

#technique_name ⇒ String

[Required] Name of the MITRE ATT@CK framework technique

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 85

def technique_name
  @technique_name
end

#time_first_detected ⇒ DateTime

[Required] The date and time the sighting was first detected. Format defined by RFC3339.

Returns:

  • (DateTime) 


101
102
103
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 101

def time_first_detected
  @time_first_detected
end

#time_last_detected ⇒ DateTime

[Required] The date and time the sighting was last detected. Format defined by RFC3339.

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 105

def time_last_detected
  @time_last_detected
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 112

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'problem_id': :'problemId',
    'actor_principal_id': :'actorPrincipalId',
    'actor_principal_name': :'actorPrincipalName',
    'actor_principal_type': :'actorPrincipalType',
    'detector_rule_id': :'detectorRuleId',
    'classification_status': :'classificationStatus',
    'sighting_type': :'sightingType',
    'sighting_type_display_name': :'sightingTypeDisplayName',
    'tactic_name': :'tacticName',
    'technique_name': :'techniqueName',
    'sighting_score': :'sightingScore',
    'severity': :'severity',
    'confidence': :'confidence',
    'time_first_detected': :'timeFirstDetected',
    'time_last_detected': :'timeLastDetected',
    'regions': :'regions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'problem_id': :'String',
    'actor_principal_id': :'String',
    'actor_principal_name': :'String',
    'actor_principal_type': :'String',
    'detector_rule_id': :'String',
    'classification_status': :'String',
    'sighting_type': :'String',
    'sighting_type_display_name': :'String',
    'tactic_name': :'String',
    'technique_name': :'String',
    'sighting_score': :'Integer',
    'severity': :'String',
    'confidence': :'String',
    'time_first_detected': :'DateTime',
    'time_last_detected': :'DateTime',
    'regions': :'Array<String>'
    # 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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 332

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    problem_id == other.problem_id &&
    actor_principal_id == other.actor_principal_id &&
    actor_principal_name == other.actor_principal_name &&
    actor_principal_type == other.actor_principal_type &&
    detector_rule_id == other.detector_rule_id &&
    classification_status == other.classification_status &&
    sighting_type == other.sighting_type &&
    sighting_type_display_name == other.sighting_type_display_name &&
    tactic_name == other.tactic_name &&
    technique_name == other.technique_name &&
    sighting_score == other.sighting_score &&
    severity == other.severity &&
    confidence == other.confidence &&
    time_first_detected == other.time_first_detected &&
    time_last_detected == other.time_last_detected &&
    regions == other.regions
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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 379

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


359
360
361
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 359

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



368
369
370
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 368

def hash
  [id, compartment_id, problem_id, actor_principal_id, actor_principal_name, actor_principal_type, detector_rule_id, classification_status, sighting_type, sighting_type_display_name, tactic_name, technique_name, sighting_score, severity, confidence, time_first_detected, time_last_detected, regions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



412
413
414
415
416
417
418
419
420
421
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 412

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



406
407
408
 
# File 'lib/oci/cloud_guard/models/sighting_summary.rb', line 406

def to_s
  to_hash.to_s
end