Class: OCI::ThreatIntelligence::Models::IndicatorSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/threat_intelligence/models/indicator_summary.rb

Overview

Summary of a data signature observed on a network or host that indicates a potential security threat.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DOMAIN_NAME = 'DOMAIN_NAME'.freeze,
  TYPE_FILE_NAME = 'FILE_NAME'.freeze,
  TYPE_MD5_HASH = 'MD5_HASH'.freeze,
  TYPE_SHA1_HASH = 'SHA1_HASH'.freeze,
  TYPE_SHA256_HASH = 'SHA256_HASH'.freeze,
  TYPE_IP_ADDRESS = 'IP_ADDRESS'.freeze,
  TYPE_URL = 'URL'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ IndicatorSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



137
138
139
140
141
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Array<OCI::ThreatIntelligence::Models::IndicatorAttributeSummary>

[Required] A map of attributes with additional information about the indicator. Each attribute has a name (string), value (string), and attribution (supporting data).

Returns:



57
58
59
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 57

def attributes
  @attributes
end

#compartment_id ⇒ String

The OCID of the compartment that contains this indicator.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 47

def compartment_id
  @compartment_id
end

#confidence ⇒ Integer

An integer from 0 to 100 that represents how certain we are that the indicator is malicious and a potential threat if it is detected communicating with your cloud resources. This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 43

def confidence
  @confidence
end

#geodata ⇒ OCI::ThreatIntelligence::Models::GeodataDetails

This attribute is required.

Returns:



77
78
79
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 77

def geodata
  @geodata
end

#id ⇒ String

[Required] The OCID of the indicator.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 31

def id
  @id
end

#lifecycle_state ⇒ String

The state of the indicator. It will always be ACTIVE.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 61

def lifecycle_state
  @lifecycle_state
end

#threat_types ⇒ Array<String>

[Required] Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.

Returns:

  • (Array<String>) 


51
52
53
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 51

def threat_types
  @threat_types
end

#time_created ⇒ DateTime

[Required] The date and time that the indicator was first detected. An RFC3339 formatted string.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 65

def time_created
  @time_created
end

#time_last_seen ⇒ DateTime

[Required] The date and time that this indicator was last seen. The value is the same as timeCreated for a new indicator. An RFC3339 formatted string.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 73

def time_last_seen
  @time_last_seen
end

#time_updated ⇒ DateTime

[Required] The date and time that this indicator was last updated by the system. Updates can include new reports or regular updates in confidence. The value is the same as timeCreated for a new indicator. An RFC3339 formatted string.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 69

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of indicator.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 35

def type
  @type
end

#value ⇒ String

[Required] The indicator data value.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 39

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'value': :'value',
    'confidence': :'confidence',
    'compartment_id': :'compartmentId',
    'threat_types': :'threatTypes',
    'attributes': :'attributes',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_last_seen': :'timeLastSeen',
    'geodata': :'geodata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 100

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'value': :'String',
    'confidence': :'Integer',
    'compartment_id': :'String',
    'threat_types': :'Array<String>',
    'attributes': :'Array<OCI::ThreatIntelligence::Models::IndicatorAttributeSummary>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_last_seen': :'DateTime',
    'geodata': :'OCI::ThreatIntelligence::Models::GeodataDetails'
    # 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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 225

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

  self.class == other.class &&
    id == other.id &&
    type == other.type &&
    value == other.value &&
    confidence == other.confidence &&
    compartment_id == other.compartment_id &&
    threat_types == other.threat_types &&
    attributes == other.attributes &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_last_seen == other.time_last_seen &&
    geodata == other.geodata
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 266

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


246
247
248
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 255

def hash
  [id, type, value, confidence, compartment_id, threat_types, attributes, lifecycle_state, time_created, time_updated, time_last_seen, geodata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 299

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



293
294
295
 
# File 'lib/oci/threat_intelligence/models/indicator_summary.rb', line 293

def to_s
  to_hash.to_s
end