Class: OCI::CloudGuard::Models::DetectorRecipeDetectorRule

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

Overview

Detector Recipe Rule

Constant Summary collapse

DETECTOR_ENUM = 
[
  DETECTOR_IAAS_ACTIVITY_DETECTOR = 'IAAS_ACTIVITY_DETECTOR'.freeze,
  DETECTOR_IAAS_CONFIGURATION_DETECTOR = 'IAAS_CONFIGURATION_DETECTOR'.freeze,
  DETECTOR_IAAS_THREAT_DETECTOR = 'IAAS_THREAT_DETECTOR'.freeze,
  DETECTOR_IAAS_LOG_INSIGHT_DETECTOR = 'IAAS_LOG_INSIGHT_DETECTOR'.freeze,
  DETECTOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANAGED_LIST_TYPES_ENUM = 
[
  MANAGED_LIST_TYPES_CIDR_BLOCK = 'CIDR_BLOCK'.freeze,
  MANAGED_LIST_TYPES_USERS = 'USERS'.freeze,
  MANAGED_LIST_TYPES_GROUPS = 'GROUPS'.freeze,
  MANAGED_LIST_TYPES_IPV4_ADDRESS = 'IPV4ADDRESS'.freeze,
  MANAGED_LIST_TYPES_IPV6_ADDRESS = 'IPV6ADDRESS'.freeze,
  MANAGED_LIST_TYPES_RESOURCE_OCID = 'RESOURCE_OCID'.freeze,
  MANAGED_LIST_TYPES_REGION = 'REGION'.freeze,
  MANAGED_LIST_TYPES_COUNTRY = 'COUNTRY'.freeze,
  MANAGED_LIST_TYPES_STATE = 'STATE'.freeze,
  MANAGED_LIST_TYPES_CITY = 'CITY'.freeze,
  MANAGED_LIST_TYPES_TAGS = 'TAGS'.freeze,
  MANAGED_LIST_TYPES_GENERIC = 'GENERIC'.freeze,
  MANAGED_LIST_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ DetectorRecipeDetectorRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 180

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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

#candidate_responder_rules ⇒ Array<OCI::CloudGuard::Models::CandidateResponderRule>

List of CandidateResponderRule related to this rule

Returns:



84
85
86
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 84

def candidate_responder_rules
  @candidate_responder_rules
end

#data_source_id ⇒ String

The id of the attached DataSource.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 104

def data_source_id
  @data_source_id
end

#description ⇒ String

Description for DetectorRecipeDetectorRule.

Returns:

  • (String) 


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

def description
  @description
end

#details ⇒ OCI::CloudGuard::Models::DetectorDetails

Returns:



76
77
78
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 76

def details
  @details
end

#detector ⇒ String

[Required] detector for the rule

Returns:

  • (String) 


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

def detector
  @detector
end

#detector_rule_id ⇒ String

[Required] The unique identifier of the detector rule.

Returns:

  • (String) 


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

def detector_rule_id
  @detector_rule_id
end

#display_name ⇒ String

Display name for DetectorRecipeDetectorRule.

Returns:

  • (String) 


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

def display_name
  @display_name
end

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

Data Source entities mapping for a Detector Rule

Returns:



108
109
110
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 108

def entities_mappings
  @entities_mappings
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 100

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the DetectorRule.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 96

def lifecycle_state
  @lifecycle_state
end

#managed_list_types ⇒ Array<String>

List of cloudguard managed list types related to this rule

Returns:

  • (Array<String>) 


80
81
82
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 80

def managed_list_types
  @managed_list_types
end

#recommendation ⇒ String

Recommendation for DetectorRecipeDetectorRule

Returns:

  • (String) 


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

def recommendation
  @recommendation
end

#resource_type ⇒ String

[Required] resource type of the configuration to which the rule is applied

Returns:

  • (String) 


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

def resource_type
  @resource_type
end

#service_type ⇒ String

[Required] service type of the configuration to which the rule is applied

Returns:

  • (String) 


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

def service_type
  @service_type
end

#time_created ⇒ DateTime

The date and time the detector recipe rule was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 88

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the detector recipe rule was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 92

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'detector_rule_id': :'detectorRuleId',
    'display_name': :'displayName',
    'description': :'description',
    'recommendation': :'recommendation',
    'detector': :'detector',
    'service_type': :'serviceType',
    'resource_type': :'resourceType',
    'details': :'details',
    'managed_list_types': :'managedListTypes',
    'candidate_responder_rules': :'candidateResponderRules',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'data_source_id': :'dataSourceId',
    'entities_mappings': :'entitiesMappings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'detector_rule_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'recommendation': :'String',
    'detector': :'String',
    'service_type': :'String',
    'resource_type': :'String',
    'details': :'OCI::CloudGuard::Models::DetectorDetails',
    'managed_list_types': :'Array<String>',
    'candidate_responder_rules': :'Array<OCI::CloudGuard::Models::CandidateResponderRule>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 320

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

  self.class == other.class &&
    detector_rule_id == other.detector_rule_id &&
    display_name == other.display_name &&
    description == other.description &&
    recommendation == other.recommendation &&
    detector == other.detector &&
    service_type == other.service_type &&
    resource_type == other.resource_type &&
    details == other.details &&
    managed_list_types == other.managed_list_types &&
    candidate_responder_rules == other.candidate_responder_rules &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 365

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


345
346
347
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 345

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 354

def hash
  [detector_rule_id, display_name, description, recommendation, detector, service_type, resource_type, details, managed_list_types, candidate_responder_rules, time_created, time_updated, lifecycle_state, lifecycle_details, 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



398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 398

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



392
393
394
 
# File 'lib/oci/cloud_guard/models/detector_recipe_detector_rule.rb', line 392

def to_s
  to_hash.to_s
end