Show / Hide Table of Contents

Class TargetDetectorRecipe

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 it\u2019s Oracle-managed, and more changes if it\u2019s 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.
Inheritance
object
TargetDetectorRecipe
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CloudguardService.Models
Assembly: OCI.DotNetSDK.Cloudguard.dll
Syntax
public class TargetDetectorRecipe

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Compartment OCID of the detector recipe

Remarks

Required

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Detector recipe description.

Detector

Declaration
[Required(ErrorMessage = "Detector is required.")]
[JsonProperty(PropertyName = "detector")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DetectorEnum? Detector { get; set; }
Property Value
Type Description
DetectorEnum?

Type of detector

Remarks

Required

DetectorRecipeId

Declaration
[Required(ErrorMessage = "DetectorRecipeId is required.")]
[JsonProperty(PropertyName = "detectorRecipeId")]
public string DetectorRecipeId { get; set; }
Property Value
Type Description
string

Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based

Remarks

Required

DetectorRecipeType

Declaration
[JsonProperty(PropertyName = "detectorRecipeType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DetectorRecipeEnum? DetectorRecipeType { get; set; }
Property Value
Type Description
DetectorRecipeEnum?

Recipe type ( STANDARD, ENTERPRISE )

DetectorRules

Declaration
[JsonProperty(PropertyName = "detectorRules")]
public List<TargetDetectorRecipeDetectorRule> DetectorRules { get; set; }
Property Value
Type Description
List<TargetDetectorRecipeDetectorRule>

List of detector rules for the detector recipe - user input

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Display name of the detector recipe

Remarks

Required

EffectiveDetectorRules

Declaration
[JsonProperty(PropertyName = "effectiveDetectorRules")]
public List<TargetDetectorRecipeDetectorRule> EffectiveDetectorRules { get; set; }
Property Value
Type Description
List<TargetDetectorRecipeDetectorRule>

List of currently enabled detector rules for the detector type for recipe after applying defaults

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

OCID for the detector recipe

Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current lifecycle state of the resource

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

Owner

Declaration
[Required(ErrorMessage = "Owner is required.")]
[JsonProperty(PropertyName = "owner")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OwnerType? Owner { get; set; }
Property Value
Type Description
OwnerType?

Owner of the detector recipe

Remarks

Required

SourceDataRetention

Declaration
[JsonProperty(PropertyName = "sourceDataRetention")]
public int? SourceDataRetention { get; set; }
Property Value
Type Description
int?

The number of days for which source data is retained

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

In this article
Back to top