Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Rule

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

Properties

actions

actions: ActionList

compartmentId

compartmentId: string

The OCID of the compartment to which this rule belongs.

condition

condition: 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: {@code {}}

For more examples, see [Matching Events with Filters](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). * 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](https://docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). * 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](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)

Example: {@code \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\"}

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | 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

displayName: string

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

Example: {@code \"This rule sends a notification upon completion of DbaaS backup.\"}

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of this rule.

isEnabled

isEnabled: boolean

Whether or not this rule is currently enabled.

Example: {@code true}

Optional lifecycleMessage

lifecycleMessage: undefined | string

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

lifecycleState

lifecycleState: LifecycleState

The current state of the rule.

timeCreated

timeCreated: Date

The time this rule was created, expressed in RFC 3339 timestamp format.

Example: {@code 2018-09-12T22:47:12.613Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Rule): object

getJsonObj

  • getJsonObj(obj: Rule): object