Package com.oracle.bmc.monitoring.model

Class Alarm.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

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

      • displayName

        public Alarm.Builder displayName​(String displayName)
        A user-friendly name for the alarm.

        It does not have to be unique, and it’s changeable.

        This value determines the title of each alarm notification.

        Example: High CPU Utilization

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

      • compartmentId

        public Alarm.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the alarm.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • metricCompartmentId

        public Alarm.Builder metricCompartmentId​(String metricCompartmentId)
        The OCID of the compartment containing the metric being evaluated by the alarm.
        Parameters:
        metricCompartmentId - the value to set
        Returns:
        this builder

      • metricCompartmentIdInSubtree

        public Alarm.Builder metricCompartmentIdInSubtree​(Boolean metricCompartmentIdInSubtree)
        When true, the alarm evaluates metrics from all compartments and subcompartments.

        The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.

        Example: true

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

      • namespace

        public Alarm.Builder namespace​(String namespace)
        The source service or application emitting the metric that is evaluated by the alarm.

        Example: oci_computeagent

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

      • resourceGroup

        public Alarm.Builder resourceGroup​(String resourceGroup)
        Resource group to match for metric data retrieved by the alarm.

        A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

        Example: frontend-fleet

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

      • query

        public Alarm.Builder query​(String query)
        The Monitoring Query Language (MQL) expression to evaluate for the alarm.

        The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

        Example of threshold alarm:

        -----

        CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85

        -----

        Example of absence alarm:

        -----

        CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()

        ----- Example of absence alarm with custom absence detection period of 20 hours:

        -----

        CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)

        -----

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

      • resolution

        public Alarm.Builder resolution​(String resolution)
        The time between calculated aggregation windows for the alarm.

        Supported value: 1m

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

      • pendingDuration

        public Alarm.Builder pendingDuration​(String pendingDuration)
        The period of time that the condition defined in the alarm must persist before the alarm state changes from “OK” to “FIRING”.

        For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to “FIRING”.

        The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.

        Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".

        The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.

        Example: PT5M

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

      • severity

        public Alarm.Builder severity​(Alarm.Severity severity)
        The perceived type of response required when the alarm is in the “FIRING” state.

        Example: CRITICAL

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

      • body

        public Alarm.Builder body​(String body)
        The human-readable content of the delivered alarm notification.

        Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.

        Example: High CPU usage alert. Follow runbook instructions for resolution.

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

      • isNotificationsPerMetricDimensionEnabled

        public Alarm.Builder isNotificationsPerMetricDimensionEnabled​(Boolean isNotificationsPerMetricDimensionEnabled)
        When set to true, splits alarm notifications per metric stream.

        When set to false, groups alarm notifications across metric streams.

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

      • messageFormat

        public Alarm.Builder messageFormat​(Alarm.MessageFormat messageFormat)
        The format to use for alarm notifications.

        The formats are: * RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format. * PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only. * ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

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

      • destinations

        public Alarm.Builder destinations​(List<String> destinations)
        A list of destinations for alarm notifications.

        Each destination is represented by the OCID of a related resource, such as a NotificationTopic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.

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

      • repeatNotificationDuration

        public Alarm.Builder repeatNotificationDuration​(String repeatNotificationDuration)
        The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption.

        Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum: PT1M. Maximum: P30D.

        Default value: null (notifications are not re-submitted).

        Example: PT2H

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

      • suppression

        public Alarm.Builder suppression​(Suppression suppression)
        The configuration details for suppressing an alarm.
        Parameters:
        suppression - the value to set
        Returns:
        this builder

      • isEnabled

        public Alarm.Builder isEnabled​(Boolean isEnabled)
        Whether the alarm is enabled.

        Example: true

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

      • freeformTags

        public Alarm.Builder freeformTags​(Map<String,​String> freeformTags)
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“Department”: “Finance”}

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

      • definedTags

        public Alarm.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Usage of predefined tag keys.

        These predefined keys are scoped to namespaces. Example: {“Operations”: {“CostCenter”: “42”}}

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

      • overrides

        public Alarm.Builder overrides​(List<AlarmOverride> overrides)
        A set of overrides that control evaluations of the alarm.

        Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm's base values (ruleName value of BASE).

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

      • ruleName

        public Alarm.Builder ruleName​(String ruleName)
        Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides.

        Default value is BASE. For information about alarm overrides, see alarmOverride.

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

      • notificationVersion

        public Alarm.Builder notificationVersion​(String notificationVersion)
        The version of the alarm notification to be delivered.

        Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

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

      • notificationTitle

        public Alarm.Builder notificationTitle​(String notificationTitle)
        Customizable notification title (title alarm message parameter).

        Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.

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

      • evaluationSlackDuration

        public Alarm.Builder evaluationSlackDuration​(String evaluationSlackDuration)
        Customizable slack period to wait for metric ingestion before evaluating the alarm.

        Specify a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.

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

      • alarmSummary

        public Alarm.Builder alarmSummary​(String alarmSummary)
        Customizable alarm summary (alarmSummary alarm message parameter).

        Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to listAlarmsStatus getAlarmHistory and retrieveDimensionStates.

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

      • lifecycleState

        public Alarm.Builder lifecycleState​(Alarm.LifecycleState lifecycleState)
        The current lifecycle state of the alarm.

        Example: DELETED

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

      • timeCreated

        public Alarm.Builder timeCreated​(Date timeCreated)
        The date and time the alarm was created.

        Format defined by RFC3339.

        Example: 2023-02-01T01:02:29.600Z

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

      • timeUpdated

        public Alarm.Builder timeUpdated​(Date timeUpdated)
        The date and time the alarm was last updated.

        Format defined by RFC3339.

        Example: 2023-02-03T01:02:29.600Z

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

      • build

        public Alarm build()