Package com.oracle.bmc.events.model

Class Rule

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class Rule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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 Rule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Rule.Builder builder()
        Create a new builder.

      • getDisplayName

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

        Returns:
        the value

      • getDescription

        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.

        Returns:
        the value

      • getLifecycleState

        public Rule.LifecycleState getLifecycleState()
        The current state of the rule.
        Returns:
        the value

      • getCondition

        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](https://docs.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.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.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)

        Example: \\"eventType\\": \\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\"

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to which this rule belongs.
        Returns:
        the value

      • getIsEnabled

        public Boolean getIsEnabled()
        Whether or not this rule is currently enabled.

        Example: true

        Returns:
        the value

      • getFreeformTags

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

        Returns:
        the value

      • getDefinedTags

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

        Returns:
        the value

      • getId

        public String getId()
        The OCID of this rule.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time this rule was created, expressed in RFC 3339 timestamp format.

        Example: 2018-09-12T22:47:12.613Z

        Returns:
        the value

      • getLifecycleMessage

        public String getLifecycleMessage()
        A message generated by the Events service about the current state of this rule.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel