Class: OCI::ThreatIntelligence::Models::Indicator

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

Overview

A data signature observed on a network or host that indicates a potential security threat. Indicators can be plain text or computed (hashed) values.

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 = {}) ⇒ Indicator

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 154

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

  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::IndicatorAttribute>

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

Returns:



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

def attributes
  @attributes
end

#compartment_id ⇒ String

The OCID of the compartment that contains this indicator.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 55

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) 


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

def confidence
  @confidence
end

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

This attribute is required.

Returns:



91
92
93
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 91

def geodata
  @geodata
end

#id ⇒ String

[Required] The OCID of the indicator.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 75

def lifecycle_state
  @lifecycle_state
end

#relationships ⇒ Array<OCI::ThreatIntelligence::Models::IndicatorRelationship>

[Required] A map of relationships between the indicator and other entities. Each relationship has a name (string), related entity, and attribution (supporting data).

Returns:



71
72
73
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 71

def relationships
  @relationships
end

#threat_types ⇒ Array<OCI::ThreatIntelligence::Models::ThreatType>

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

Returns:



59
60
61
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 59

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) 


79
80
81
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 79

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) 


87
88
89
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 87

def time_last_seen
  @time_last_seen
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 83

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.rb', line 35

def type
  @type
end

#value ⇒ String

[Required] The value for this indicator. The value's format is dependent upon its type. Examples:

DOMAIN_NAME "evil.example.com"

MD5_HASH "44d88612fea8a8f36de82e1278abb02f"

IP_ADDRESS "2001:db8::1"

Returns:

  • (String) 


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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 94

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'value': :'value',
    'confidence': :'confidence',
    'compartment_id': :'compartmentId',
    'threat_types': :'threatTypes',
    'attributes': :'attributes',
    'relationships': :'relationships',
    '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.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 115

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'value': :'String',
    'confidence': :'Integer',
    'compartment_id': :'String',
    'threat_types': :'Array<OCI::ThreatIntelligence::Models::ThreatType>',
    'attributes': :'Array<OCI::ThreatIntelligence::Models::IndicatorAttribute>',
    'relationships': :'Array<OCI::ThreatIntelligence::Models::IndicatorRelationship>',
    '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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 244

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 &&
    relationships == other.relationships &&
    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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 286

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


266
267
268
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 266

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 275

def hash
  [id, type, value, confidence, compartment_id, threat_types, attributes, relationships, 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



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 319

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



313
314
315
 
# File 'lib/oci/threat_intelligence/models/indicator.rb', line 313

def to_s
  to_hash.to_s
end