Class: OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule

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

Overview

A TargetDetectorRecipeDetectorRule resource contains a specific instance of a single detector rule in one of the supported detector types (for example, activity, configuration, or threat).

A TargetDetectorRecipeDetectorRule resource: * Is effectively a copy of a DetectorRecipeRule resource (made when a detector recipe is attached to a target) in which users can make certain changes if itu2019s Oracle-managed, and other changes if itu2019s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is effectively located in a specific OCI compartment, through the ThreatDetectorRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply locally, to resources in OCI compartments mapped to the target that attaches the associated detector recipe (in a TargetDetectorRecipe resource), and override any changes made in rules associated with the corresponding DetectorRecipe resource.

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_IAAS_INSTANCE_SECURITY_DETECTOR = 'IAAS_INSTANCE_SECURITY_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_FUSION_APPS_ROLE = 'FUSION_APPS_ROLE'.freeze,
  MANAGED_LIST_TYPES_FUSION_APPS_PERMISSION = 'FUSION_APPS_PERMISSION'.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 = {}) ⇒ TargetDetectorRecipeDetectorRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 206

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.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']

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

Instance Attribute Details

#data_source_idString

The ID of the attached data source

Returns:

  • (String)


126
127
128
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 126

def data_source_id
  @data_source_id
end

#descriptionString

Description for TargetDetectorRecipeDetectorRule resource

Returns:

  • (String)


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

def description
  @description
end

#detailsOCI::CloudGuard::Models::TargetDetectorDetails



102
103
104
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 102

def details
  @details
end

#detectorString

[Required] Detector type for the rule

Returns:

  • (String)


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

def detector
  @detector
end

#detector_rule_idString

[Required] The unique identifier of the detector rule

Returns:

  • (String)


68
69
70
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 68

def detector_rule_id
  @detector_rule_id
end

#display_nameString

Display name for TargetDetectorRecipeDetectorRule resource

Returns:

  • (String)


72
73
74
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 72

def display_name
  @display_name
end

#entities_mappingsArray<OCI::CloudGuard::Models::EntitiesMapping>

Data source entities mapping for a detector rule



130
131
132
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 130

def entities_mappings
  @entities_mappings
end

#lifecycle_detailsString

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)


122
123
124
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 122

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

The current lifecycle state of the detector rule

Returns:

  • (String)


118
119
120
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 118

def lifecycle_state
  @lifecycle_state
end

#locksArray<OCI::CloudGuard::Models::ResourceLock>

Locks associated with this resource.



134
135
136
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 134

def locks
  @locks
end

#managed_list_typesArray<String>

List of managed list types related to this rule

Returns:

  • (Array<String>)


106
107
108
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 106

def managed_list_types
  @managed_list_types
end

#recommendationString

Recommendation for TargetDetectorRecipeDetectorRule resource

Returns:

  • (String)


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

def recommendation
  @recommendation
end

#resource_typeString

[Required] The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).

Or try [Detector Recipe Reference] (/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).

Returns:

  • (String)


99
100
101
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 99

def resource_type
  @resource_type
end

#service_typeString

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

Returns:

  • (String)


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

def service_type
  @service_type
end

#time_createdDateTime

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

Returns:

  • (DateTime)


110
111
112
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 110

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


114
115
116
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 114

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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

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',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'data_source_id': :'dataSourceId',
    'entities_mappings': :'entitiesMappings',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 161

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::TargetDetectorDetails',
    'managed_list_types': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'data_source_id': :'String',
    'entities_mappings': :'Array<OCI::CloudGuard::Models::EntitiesMapping>',
    'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>'
    # 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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 342

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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 387

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


367
368
369
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 367

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



376
377
378
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 376

def hash
  [detector_rule_id, display_name, description, recommendation, detector, service_type, resource_type, details, managed_list_types, time_created, time_updated, lifecycle_state, lifecycle_details, data_source_id, entities_mappings, locks].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



420
421
422
423
424
425
426
427
428
429
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 420

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



414
415
416
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule.rb', line 414

def to_s
  to_hash.to_s
end