Class DetectorRecipe

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.

Inheritance

object

DetectorRecipe

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 DetectorRecipe

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	Compartment OCID of detector recipe

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

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

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<DetectorRecipeDetectorRule> DetectorRules { get; set; }

Property Value

Type	Description
List<DetectorRecipeDetectorRule>	List of detector rules for the detector type for 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 detector recipe

Remarks

Required

EffectiveDetectorRules

Declaration

[JsonProperty(PropertyName = "effectiveDetectorRules")]
public List<DetectorRecipeDetectorRule> EffectiveDetectorRules { get; set; }

Property Value

Type	Description
List<DetectorRecipeDetectorRule>	List of effective detector rules for the detector type for recipe after applying defaults

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<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.

Id

Declaration

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

Property Value

Type	Description
string	OCID for 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

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 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

SourceDetectorRecipeId

Declaration

[Required(ErrorMessage = "SourceDetectorRecipeId is required.")]
[JsonProperty(PropertyName = "sourceDetectorRecipeId")]
public string SourceDetectorRecipeId { get; set; }

Property Value

Type	Description
string	Recipe OCID of the source recipe to be cloned

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<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"}}

TargetIds

Declaration

[JsonProperty(PropertyName = "targetIds")]
public List<string> TargetIds { get; set; }

Property Value

Type	Description
List<string>	List of target IDs to which the recipe is attached

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the 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 detector recipe was last updated Format defined by RFC3339.