Class: OCI::CloudGuard::Models::DetectorDetails

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

Overview

Detailed information for a detector.

Constant Summary collapse

RISK_LEVEL_ENUM = 
[
  RISK_LEVEL_CRITICAL = 'CRITICAL'.freeze,
  RISK_LEVEL_HIGH = 'HIGH'.freeze,
  RISK_LEVEL_MEDIUM = 'MEDIUM'.freeze,
  RISK_LEVEL_LOW = 'LOW'.freeze,
  RISK_LEVEL_MINOR = 'MINOR'.freeze,
  RISK_LEVEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetectorDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



133
134
135
136
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
191
192
193
194
195
196
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 133

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

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

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

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

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

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

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

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

  self.is_configuration_allowed = attributes[:'isConfigurationAllowed'] unless attributes[:'isConfigurationAllowed'].nil?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#condition ⇒ OCI::CloudGuard::Models::Condition

Returns:



34
35
36
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 34

def condition
  @condition
end

#configurations ⇒ Array<OCI::CloudGuard::Models::DetectorConfiguration>

List of detector rule configurations

Returns:



31
32
33
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 31

def configurations
  @configurations
end

#data_source_id ⇒ String

The ID of the attached data source

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 66

def data_source_id
  @data_source_id
end

#description ⇒ String

Description for detector recipe detector rule

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 58

def description
  @description
end

#entities_mappings ⇒ Array<OCI::CloudGuard::Models::EntitiesMapping>

Data source entities mapping for a detector rule

Returns:



70
71
72
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 70

def entities_mappings
  @entities_mappings
end

#is_configuration_allowed ⇒ BOOLEAN

Can the rule be configured?

Returns:

  • (BOOLEAN) 


42
43
44
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 42

def is_configuration_allowed
  @is_configuration_allowed
end

#is_enabled ⇒ BOOLEAN

[Required] Enablement status for the rule

Returns:

  • (BOOLEAN) 


23
24
25
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 23

def is_enabled
  @is_enabled
end

#labels ⇒ Array<String>

User-defined labels for a detector rule

Returns:

  • (Array<String>) 


38
39
40
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 38

def labels
  @labels
end

#problem_threshold ⇒ Integer

The point at which an elevated resource risk score creates a problem

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 46

def problem_threshold
  @problem_threshold
end

#recommendation ⇒ String

Recommendation for detector recipe detector rule

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 62

def recommendation
  @recommendation
end

#risk_level ⇒ String

The risk level for the rule

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 27

def risk_level
  @risk_level
end

#sighting_types ⇒ Array<OCI::CloudGuard::Models::SightingType>

List of sighting types

Returns:



54
55
56
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 54

def sighting_types
  @sighting_types
end

#target_types ⇒ Array<String>

List of target types for which the detector rule is applicable

Returns:

  • (Array<String>) 


50
51
52
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 50

def target_types
  @target_types
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'risk_level': :'riskLevel',
    'configurations': :'configurations',
    'condition': :'condition',
    'labels': :'labels',
    'is_configuration_allowed': :'isConfigurationAllowed',
    'problem_threshold': :'problemThreshold',
    'target_types': :'targetTypes',
    'sighting_types': :'sightingTypes',
    'description': :'description',
    'recommendation': :'recommendation',
    'data_source_id': :'dataSourceId',
    'entities_mappings': :'entitiesMappings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'risk_level': :'String',
    'configurations': :'Array<OCI::CloudGuard::Models::DetectorConfiguration>',
    'condition': :'OCI::CloudGuard::Models::Condition',
    'labels': :'Array<String>',
    'is_configuration_allowed': :'BOOLEAN',
    'problem_threshold': :'Integer',
    'target_types': :'Array<String>',
    'sighting_types': :'Array<OCI::CloudGuard::Models::SightingType>',
    'description': :'String',
    'recommendation': :'String',
    'data_source_id': :'String',
    'entities_mappings': :'Array<OCI::CloudGuard::Models::EntitiesMapping>'
    # 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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 218

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    risk_level == other.risk_level &&
    configurations == other.configurations &&
    condition == other.condition &&
    labels == other.labels &&
    is_configuration_allowed == other.is_configuration_allowed &&
    problem_threshold == other.problem_threshold &&
    target_types == other.target_types &&
    sighting_types == other.sighting_types &&
    description == other.description &&
    recommendation == other.recommendation &&
    data_source_id == other.data_source_id &&
    entities_mappings == other.entities_mappings
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 260

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


240
241
242
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 240

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 249

def hash
  [is_enabled, risk_level, configurations, condition, labels, is_configuration_allowed, problem_threshold, target_types, sighting_types, description, recommendation, data_source_id, entities_mappings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 293

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



287
288
289
 
# File 'lib/oci/cloud_guard/models/detector_details.rb', line 287

def to_s
  to_hash.to_s
end