Package com.oracle.bmc.monitoring.model

Class AlarmSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public AlarmSummary.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 AlarmSummary.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the alarm.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • metricCompartmentId

        public AlarmSummary.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

      • namespace

        public AlarmSummary.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

      • query

        public AlarmSummary.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. 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()

        -----

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

      • severity

        public AlarmSummary.Builder severity​(AlarmSummary.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

      • destinations

        public AlarmSummary.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

      • suppression

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

      • isEnabled

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

        Example: true

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

      • freeformTags

        public AlarmSummary.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 AlarmSummary.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

      • lifecycleState

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

        Example: DELETED

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

      • overrides

        public AlarmSummary.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 AlarmSummary.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 AlarmSummary.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 AlarmSummary.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 AlarmSummary.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 AlarmSummary.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

      • resourceGroup

        public AlarmSummary.Builder resourceGroup​(String resourceGroup)
        Resource group that you want to match.

        A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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