Class: OCI::CloudGuard::Models::DetectorRecipe
- Inherits:
-
Object
- Object
- OCI::CloudGuard::Models::DetectorRecipe
- Defined in:
- lib/oci/cloud_guard/models/detector_recipe.rb
Overview
A detector recipe is a collection of rules that can be configured to trigger problems that appear on the Cloud Guard Problems page. A DetectorRecipe resource contains settings for a specific detector recipe, plus a list of the detector rules (DetectorRecipeDetectorRule resources) belonging to the DetectorRecipe resource.
Constant Summary collapse
- DETECTOR_RECIPE_TYPE_ENUM =
[ DETECTOR_RECIPE_TYPE_LIMITED = 'LIMITED'.freeze, DETECTOR_RECIPE_TYPE_BASIC = 'BASIC'.freeze, DETECTOR_RECIPE_TYPE_STANDARD = 'STANDARD'.freeze, DETECTOR_RECIPE_TYPE_ENTERPRISE = 'ENTERPRISE'.freeze, DETECTOR_RECIPE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- OWNER_ENUM =
[ OWNER_CUSTOMER = 'CUSTOMER'.freeze, OWNER_ORACLE = 'ORACLE'.freeze, OWNER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- 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
- 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
-
#compartment_id ⇒ String
[Required] Compartment OCID of detector recipe.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
Detector recipe description.
-
#detector ⇒ String
[Required] Type of detector.
-
#detector_recipe_type ⇒ String
Recipe type ( STANDARD, ENTERPRISE ).
-
#detector_rules ⇒ Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>
List of detector rules for the detector type for recipe - user input.
-
#display_name ⇒ String
[Required] Display name of detector recipe.
-
#effective_detector_rules ⇒ Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>
List of effective detector rules for the detector type for recipe after applying defaults.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] OCID for detector recipe.
-
#lifecycle_state ⇒ String
The current lifecycle state of the resource.
-
#owner ⇒ String
[Required] Owner of detector recipe.
-
#source_data_retention ⇒ Integer
The number of days for which source data is retained.
-
#source_detector_recipe_id ⇒ String
[Required] Recipe OCID of the source recipe to be cloned.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#target_ids ⇒ Array<String>
List of target IDs to which the recipe is attached.
-
#time_created ⇒ DateTime
The date and time the detector recipe was created Format defined by RFC3339.
-
#time_updated ⇒ DateTime
The date and time the detector recipe was last updated Format defined by RFC3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DetectorRecipe
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ DetectorRecipe
Initializes the object
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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 205 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.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.source_detector_recipe_id = attributes[:'sourceDetectorRecipeId'] if attributes[:'sourceDetectorRecipeId'] raise 'You cannot provide both :sourceDetectorRecipeId and :source_detector_recipe_id' if attributes.key?(:'sourceDetectorRecipeId') && attributes.key?(:'source_detector_recipe_id') self.source_detector_recipe_id = attributes[:'source_detector_recipe_id'] if attributes[:'source_detector_recipe_id'] self.detector_recipe_type = attributes[:'detectorRecipeType'] if attributes[:'detectorRecipeType'] raise 'You cannot provide both :detectorRecipeType and :detector_recipe_type' if attributes.key?(:'detectorRecipeType') && attributes.key?(:'detector_recipe_type') self.detector_recipe_type = attributes[:'detector_recipe_type'] if attributes[:'detector_recipe_type'] self.owner = attributes[:'owner'] if attributes[:'owner'] self.detector = attributes[:'detector'] if attributes[:'detector'] self.detector_rules = attributes[:'detectorRules'] if attributes[:'detectorRules'] raise 'You cannot provide both :detectorRules and :detector_rules' if attributes.key?(:'detectorRules') && attributes.key?(:'detector_rules') self.detector_rules = attributes[:'detector_rules'] if attributes[:'detector_rules'] self.effective_detector_rules = attributes[:'effectiveDetectorRules'] if attributes[:'effectiveDetectorRules'] raise 'You cannot provide both :effectiveDetectorRules and :effective_detector_rules' if attributes.key?(:'effectiveDetectorRules') && attributes.key?(:'effective_detector_rules') self.effective_detector_rules = attributes[:'effective_detector_rules'] if attributes[:'effective_detector_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.source_data_retention = attributes[:'sourceDataRetention'] if attributes[:'sourceDataRetention'] raise 'You cannot provide both :sourceDataRetention and :source_data_retention' if attributes.key?(:'sourceDataRetention') && attributes.key?(:'source_data_retention') self.source_data_retention = attributes[:'source_data_retention'] if attributes[:'source_data_retention'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] self.target_ids = attributes[:'targetIds'] if attributes[:'targetIds'] raise 'You cannot provide both :targetIds and :target_ids' if attributes.key?(:'targetIds') && attributes.key?(:'target_ids') self.target_ids = attributes[:'target_ids'] if attributes[:'target_ids'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] Compartment OCID of detector recipe
60 61 62 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 60 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
114 115 116 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 114 def @defined_tags end |
#description ⇒ String
Detector recipe description
56 57 58 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 56 def description @description end |
#detector ⇒ String
[Required] Type of detector
76 77 78 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 76 def detector @detector end |
#detector_recipe_type ⇒ String
Recipe type ( STANDARD, ENTERPRISE )
68 69 70 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 68 def detector_recipe_type @detector_recipe_type end |
#detector_rules ⇒ Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>
List of detector rules for the detector type for recipe - user input
80 81 82 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 80 def detector_rules @detector_rules end |
#display_name ⇒ String
[Required] Display name of detector recipe
52 53 54 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 52 def display_name @display_name end |
#effective_detector_rules ⇒ Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>
List of effective detector rules for the detector type for recipe after applying defaults
84 85 86 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 84 def effective_detector_rules @effective_detector_rules end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
Avoid entering confidential information.
108 109 110 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 108 def @freeform_tags end |
#id ⇒ String
[Required] OCID for detector recipe
48 49 50 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 48 def id @id end |
#lifecycle_state ⇒ String
The current lifecycle state of the resource
96 97 98 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 96 def lifecycle_state @lifecycle_state end |
#owner ⇒ String
[Required] Owner of detector recipe
72 73 74 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 72 def owner @owner end |
#source_data_retention ⇒ Integer
The number of days for which source data is retained
100 101 102 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 100 def source_data_retention @source_data_retention end |
#source_detector_recipe_id ⇒ String
[Required] Recipe OCID of the source recipe to be cloned
64 65 66 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 64 def source_detector_recipe_id @source_detector_recipe_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
123 124 125 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 123 def @system_tags end |
#target_ids ⇒ Array<String>
List of target IDs to which the recipe is attached
127 128 129 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 127 def target_ids @target_ids end |
#time_created ⇒ DateTime
The date and time the detector recipe was created Format defined by RFC3339.
88 89 90 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 88 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the detector recipe was last updated Format defined by RFC3339.
92 93 94 |
# File 'lib/oci/cloud_guard/models/detector_recipe.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.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 130 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'compartment_id': :'compartmentId', 'source_detector_recipe_id': :'sourceDetectorRecipeId', 'detector_recipe_type': :'detectorRecipeType', 'owner': :'owner', 'detector': :'detector', 'detector_rules': :'detectorRules', 'effective_detector_rules': :'effectiveDetectorRules', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'source_data_retention': :'sourceDataRetention', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'target_ids': :'targetIds' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 156 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'compartment_id': :'String', 'source_detector_recipe_id': :'String', 'detector_recipe_type': :'String', 'owner': :'String', 'detector': :'String', 'detector_rules': :'Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>', 'effective_detector_rules': :'Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'source_data_retention': :'Integer', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'target_ids': :'Array<String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 363 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && description == other.description && compartment_id == other.compartment_id && source_detector_recipe_id == other.source_detector_recipe_id && detector_recipe_type == other.detector_recipe_type && owner == other.owner && detector == other.detector && detector_rules == other.detector_rules && effective_detector_rules == other.effective_detector_rules && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && source_data_retention == other.source_data_retention && == other. && == other. && == other. && target_ids == other.target_ids end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 410 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
390 391 392 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 390 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
399 400 401 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 399 def hash [id, display_name, description, compartment_id, source_detector_recipe_id, detector_recipe_type, owner, detector, detector_rules, effective_detector_rules, time_created, time_updated, lifecycle_state, source_data_retention, , , , target_ids].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
443 444 445 446 447 448 449 450 451 452 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 443 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
437 438 439 |
# File 'lib/oci/cloud_guard/models/detector_recipe.rb', line 437 def to_s to_hash.to_s end |