Package com.oracle.bmc.events.model

Class Rule.Builder

  • Enclosing class:
    Rule
    public static class Rule.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public Rule.Builder displayName​(String displayName)
        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."

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public Rule.Builder description​(String description)
        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.

        Parameters:
        description - the value to set
        Returns:
        this builder

      • lifecycleState

        public Rule.Builder lifecycleState​(Rule.LifecycleState lifecycleState)
        The current state of the rule.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • condition

        public Rule.Builder condition​(String condition)
        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\\"

        Parameters:
        condition - the value to set
        Returns:
        this builder

      • compartmentId

        public Rule.Builder compartmentId​(String compartmentId)
        The OCID of the compartment to which this rule belongs.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • isEnabled

        public Rule.Builder isEnabled​(Boolean isEnabled)
        Whether or not this rule is currently enabled.

        Example: true

        Parameters:
        isEnabled - the value to set
        Returns:
        this builder

      • freeformTags

        public Rule.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public Rule.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • id

        public Rule.Builder id​(String id)
        The OCID of this rule.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • timeCreated

        public Rule.Builder timeCreated​(Date timeCreated)
        The time this rule was created, expressed in RFC 3339 timestamp format.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • lifecycleMessage

        public Rule.Builder lifecycleMessage​(String lifecycleMessage)
        A message generated by the Events service about the current state of this rule.
        Parameters:
        lifecycleMessage - the value to set
        Returns:
        this builder

      • build

        public Rule build()