Class: OCI::CloudGuard::Models::TargetDetectorRecipe
- Inherits:
-
Object
- Object
- OCI::CloudGuard::Models::TargetDetectorRecipe
- Defined in:
- lib/oci/cloud_guard/models/target_detector_recipe.rb
Overview
A TargetDetectorRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target.
A TargetDetectorRecipe resource: * Is effectively a copy of a DetectorRecipe resource in which users can make very limited changes if itu2019s Oracle-managed, and more changes if itu2019s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding DetectorRecipe, of which the TargetDetectorRecipe resource is effectively a copy, created when the detector recipe is attached to the target.
Constant Summary collapse
- 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
- 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
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] Compartment OCID of the detector recipe.
-
#description ⇒ String
Detector recipe description.
-
#detector ⇒ String
[Required] Type of detector.
-
#detector_recipe_id ⇒ String
[Required] Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based.
-
#detector_recipe_type ⇒ String
Recipe type ( STANDARD, ENTERPRISE ).
-
#detector_rules ⇒ Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>
List of detector rules for the detector recipe - user input.
-
#display_name ⇒ String
[Required] Display name of the detector recipe.
-
#effective_detector_rules ⇒ Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>
List of currently enabled detector rules for the detector type for recipe after applying defaults.
-
#id ⇒ String
[Required] OCID for the detector recipe.
-
#lifecycle_state ⇒ String
The current lifecycle state of the resource.
-
#locks ⇒ Array<OCI::CloudGuard::Models::ResourceLock>
Locks associated with this resource.
-
#owner ⇒ String
[Required] Owner of the detector recipe.
-
#source_data_retention ⇒ Integer
The number of days for which source data is retained.
-
#time_created ⇒ DateTime
The date and time the target detector recipe was created.
-
#time_updated ⇒ DateTime
The date and time the target detector recipe was last updated.
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 = {}) ⇒ TargetDetectorRecipe
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 = {}) ⇒ TargetDetectorRecipe
Initializes the object
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 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 186 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.detector_recipe_id = attributes[:'detectorRecipeId'] if attributes[:'detectorRecipeId'] raise 'You cannot provide both :detectorRecipeId and :detector_recipe_id' if attributes.key?(:'detectorRecipeId') && attributes.key?(:'detector_recipe_id') self.detector_recipe_id = attributes[:'detector_recipe_id'] if attributes[:'detector_recipe_id'] 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.locks = attributes[:'locks'] if attributes[:'locks'] 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.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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] Compartment OCID of the detector recipe
73 74 75 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 73 def compartment_id @compartment_id end |
#description ⇒ String
Detector recipe description.
69 70 71 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 69 def description @description end |
#detector ⇒ String
[Required] Type of detector
85 86 87 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 85 def detector @detector end |
#detector_recipe_id ⇒ String
[Required] Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based
77 78 79 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 77 def detector_recipe_id @detector_recipe_id end |
#detector_recipe_type ⇒ String
Recipe type ( STANDARD, ENTERPRISE )
113 114 115 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 113 def detector_recipe_type @detector_recipe_type end |
#detector_rules ⇒ Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>
List of detector rules for the detector recipe - user input
89 90 91 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 89 def detector_rules @detector_rules end |
#display_name ⇒ String
[Required] Display name of the detector recipe
65 66 67 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 65 def display_name @display_name end |
#effective_detector_rules ⇒ Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>
List of currently enabled detector rules for the detector type for recipe after applying defaults
93 94 95 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 93 def effective_detector_rules @effective_detector_rules end |
#id ⇒ String
[Required] OCID for the detector recipe
61 62 63 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 61 def id @id end |
#lifecycle_state ⇒ String
The current lifecycle state of the resource
105 106 107 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 105 def lifecycle_state @lifecycle_state end |
#locks ⇒ Array<OCI::CloudGuard::Models::ResourceLock>
Locks associated with this resource.
109 110 111 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 109 def locks @locks end |
#owner ⇒ String
[Required] Owner of the detector recipe
81 82 83 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 81 def owner @owner end |
#source_data_retention ⇒ Integer
The number of days for which source data is retained
117 118 119 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 117 def source_data_retention @source_data_retention end |
#time_created ⇒ DateTime
The date and time the target detector recipe was created. Format defined by RFC3339.
97 98 99 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 97 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time the target detector recipe was last updated. Format defined by RFC3339.
101 102 103 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 101 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 120 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'description': :'description', 'compartment_id': :'compartmentId', 'detector_recipe_id': :'detectorRecipeId', 'owner': :'owner', 'detector': :'detector', 'detector_rules': :'detectorRules', 'effective_detector_rules': :'effectiveDetectorRules', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'locks': :'locks', 'detector_recipe_type': :'detectorRecipeType', 'source_data_retention': :'sourceDataRetention' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 143 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'description': :'String', 'compartment_id': :'String', 'detector_recipe_id': :'String', 'owner': :'String', 'detector': :'String', 'detector_rules': :'Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>', 'effective_detector_rules': :'Array<OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRule>', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>', 'detector_recipe_type': :'String', 'source_data_retention': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 322 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 && detector_recipe_id == other.detector_recipe_id && 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 && locks == other.locks && detector_recipe_type == other.detector_recipe_type && source_data_retention == other.source_data_retention end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 366 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
346 347 348 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 346 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
355 356 357 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 355 def hash [id, display_name, description, compartment_id, detector_recipe_id, owner, detector, detector_rules, effective_detector_rules, time_created, time_updated, lifecycle_state, locks, detector_recipe_type, source_data_retention].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
399 400 401 402 403 404 405 406 407 408 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 399 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
393 394 395 |
# File 'lib/oci/cloud_guard/models/target_detector_recipe.rb', line 393 def to_s to_hash.to_s end |