@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class Rule extends Object
The configuration details of an Events rule. For more information, see Managing Rules for Events
Note: Objects should always be created or deserialized using the Rule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Rule.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Rule.Builder |
static class |
Rule.LifecycleState
The current state of the rule.
|
| Constructor and Description |
|---|
Rule(String displayName,
String description,
Rule.LifecycleState lifecycleState,
String condition,
String compartmentId,
Boolean isEnabled,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
ActionList actions,
String id,
Date timeCreated,
String lifecycleMessage)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Rule.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
ActionList |
getActions() |
String |
getCompartmentId()
The OCID of the compartment to which this rule belongs.
|
String |
getCondition()
A filter that specifies the event that will trigger actions associated with this rule.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A string that describes the details of the rule.
|
String |
getDisplayName()
A string that describes the rule.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of this rule.
|
Boolean |
getIsEnabled()
Whether or not this rule is currently enabled.
|
String |
getLifecycleMessage()
A message generated by the Events service about the current state of this rule.
|
Rule.LifecycleState |
getLifecycleState()
The current state of the rule.
|
Date |
getTimeCreated()
The time this rule was created, expressed in RFC 3339 timestamp format.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"displayName","description","lifecycleState","condition","compartmentId","isEnabled","freeformTags","definedTags","actions","id","timeCreated","lifecycleMessage"}) @Deprecated public Rule(String displayName, String description, Rule.LifecycleState lifecycleState, String condition, String compartmentId, Boolean isEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, ActionList actions, String id, Date timeCreated, String lifecycleMessage)
public static Rule.Builder builder()
Create a new builder.
public String getDisplayName()
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.\"
public String getDescription()
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.
public Rule.LifecycleState getLifecycleState()
The current state of the rule.
public String getCondition()
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 fileds 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. * The condition is a string value in a JSON object, but numbers in conditions are converted from strings to numbers before they are evaluated for matches. This means that 100, 100.0 or 1.0e2 are all considered equal. * Boolean values are converted to numbers and then evaluated. This means true and True are considered equal, as are False and false. * 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\\\"
public String getCompartmentId()
The OCID of the compartment to which this rule belongs.
public Boolean getIsEnabled()
Whether or not this rule is currently enabled.
Example: true
public Map<String,String> getFreeformTags()
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\"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
public ActionList getActions()
public Date getTimeCreated()
The time this rule was created, expressed in RFC 3339 timestamp format.
Example: 2018-09-12T22:47:12.613Z
public String getLifecycleMessage()
A message generated by the Events service about the current state of this rule.
Copyright © 2016–2020. All rights reserved.