Class: OCI::CloudGuard::Models::SightingType

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

Overview

Specific behavior that can trigger a Sighting

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SightingType

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :mitre_link (String) —

    The value to assign to the #mitre_link property

  • :tactic (String) —

    The value to assign to the #tactic property

  • :techniques (Array<String>) —

    The value to assign to the #techniques property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 75

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ String

Description of the sighting type

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 21

def description
  @description
end

#display_name ⇒ String

Name of the sighting type

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 17

def display_name
  @display_name
end

#id ⇒ String

The unique identifier of sighting type

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 13

def id
  @id
end

#mitre_link ⇒ String

Link of the sighting type

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 25

def mitre_link
  @mitre_link
end

#tactic ⇒ String

Mitre Att&ck tactic

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 29

def tactic
  @tactic
end

#techniques ⇒ Array<String>

List of Mitre Att&ck Techniques

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 33

def techniques
  @techniques
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'mitre_link': :'mitreLink',
    'tactic': :'tactic',
    'techniques': :'techniques'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'mitre_link': :'String',
    'tactic': :'String',
    'techniques': :'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



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 109

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    mitre_link == other.mitre_link &&
    tactic == other.tactic &&
    techniques == other.techniques
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 144

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


124
125
126
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 133

def hash
  [id, display_name, description, mitre_link, tactic, techniques].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 177

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



171
172
173
 
# File 'lib/oci/cloud_guard/models/sighting_type.rb', line 171

def to_s
  to_hash.to_s
end