Package com.oracle.bmc.monitoring.model

Class CreateAlarmSuppressionDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class CreateAlarmSuppressionDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The configuration details for creating an alarm suppression.
    Note: Objects should always be created or deserialized using the CreateAlarmSuppressionDetails.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 CreateAlarmSuppressionDetails.Builder, which maintain a set of all explicitly set fields called CreateAlarmSuppressionDetails.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

      • getLevel

        public AlarmSuppression.Level getLevel()
        The level of this alarm suppression.

        ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

        Defaut: DIMENSION

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the alarm suppression.

        It does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Human-readable reason for this alarm suppression.

        It does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Oracle recommends including tracking information for the event or associated work, such as a ticket number.

        Example: Planned outage due to change IT-1234.

        Returns:
        the value

      • getDimensions

        public Map<String,​String> getDimensions()
        A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs.

        If you specify {“availabilityDomain”: “phx-ad-1”} and the alarm state entry corresponds to the set {“availabilityDomain”: “phx-ad-1” and “resourceId”: “ocid1.instance.region1.phx.exampleuniqueID”}, then this alarm will be included for suppression.

        This is required only when the value of level is DIMENSION. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

        Returns:
        the value

      • getTimeSuppressFrom

        public Date getTimeSuppressFrom()
        The start date and time for the suppression to take place, inclusive.

        Format defined by RFC3339.

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

        Returns:
        the value

      • getTimeSuppressUntil

        public Date getTimeSuppressUntil()
        The end date and time for the suppression to take place, inclusive.

        Format defined by RFC3339.

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

        Returns:
        the value

      • getFreeformTags

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

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

        Returns:
        the value

      • getDefinedTags

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

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

        Returns:
        the value

      • getSuppressionConditions

        public List<SuppressionCondition> getSuppressionConditions()
        Array of all preconditions for alarm suppression.

        Example: [{ conditionType: “RECURRENCE”, suppressionRecurrence: “FRQ=DAILY;BYHOUR=10”, suppressionDuration: “PT1H” }]

        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