Class Rule

The configuration details of an Events rule. For more information, see Managing Rules for Events.

Inheritance

object

Rule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.EventsService.Models

Assembly: OCI.DotNetSDK.Events.dll

Syntax

public class Rule

Properties

Actions

Declaration

[Required(ErrorMessage = "Actions is required.")]
[JsonProperty(PropertyName = "actions")]
public ActionList Actions { get; set; }

Property Value

Type	Description
ActionList

Remarks

Required

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment to which this rule belongs.

Remarks

Required

Condition

Declaration

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

Property Value

Type

Description

string

A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters: Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {} For more examples, see Matching Events with Filters. For a condition with fields to match an event, the event must contain all the field names listed in the condition. Field names must appear in the condition with the same nesting structure used in the event. For a list of reference events, see Services that Produce Events. Rules apply to events in the compartment in which you create them and any child compartments. This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments. Wildcard matching is supported with the asterisk (*) character. For examples of wildcard matching, see Matching Events with Filters Example: \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

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

Property Value

Type	Description
string	A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.

DisplayName

Declaration

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

Property Value

Type	Description
string	A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup."

Remarks

Required

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of this rule.

Remarks

Required

IsEnabled

Declaration

[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	Whether or not this rule is currently enabled. Example: true

Remarks

Required

LifecycleMessage

Declaration

[JsonProperty(PropertyName = "lifecycleMessage")]
public string LifecycleMessage { get; set; }

Property Value

Type	Description
string	A message generated by the Events service about the current state of this rule.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Rule.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Rule.LifecycleStateEnum?	The current state of the rule.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time this rule was created, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

Remarks

Required