Package com.oracle.bmc.monitoring.requests

Class ListAlarmSuppressionsRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public class ListAlarmSuppressionsRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/monitoring/ListAlarmSuppressionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAlarmSuppressionsRequest.

    • Constructor Detail

      • ListAlarmSuppressionsRequest

        public ListAlarmSuppressionsRequest()

    • Method Detail

      • getOpcRequestId

        public String getOpcRequestId()
        Customer part of the request identifier token.

        If you need to contact Oracle about a particular request, please provide the complete request ID.

      • getAlarmId

        public String getAlarmId()
        The OCID of the alarm that is the target of the alarm suppression.

      • getDisplayName

        public String getDisplayName()
        A filter to return only resources that match the given display name exactly.

        Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.

      • getLifecycleState

        public AlarmSuppression.LifecycleState getLifecycleState()
        A filter to return only resources that match the given lifecycle state exactly.

        When not specified, only resources in the ACTIVE lifecycle state are listed.

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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment for searching.

        Use the tenancy OCID to search in the root compartment.

        If targetType is not specified, searches all suppressions defined under the compartment. If targetType is COMPARTMENT, searches suppressions in the specified compartment only.

        Example: ocid1.compartment.oc1..exampleuniqueID

      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        When true, returns resources from all compartments and subcompartments.

        The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.

      • getTargetType

        public ListAlarmSuppressionsRequest.TargetType getTargetType()
        The target type to use when listing alarm suppressions.

        ALARM lists all suppression records for the specified alarm. COMPARTMENT lists all suppression records for the specified compartment or tenancy.

      • getIsAllSuppressions

        public Boolean getIsAllSuppressions()
        Setting this parameter to true requires the query to specify the alarm (alarmId).

        When true, lists all alarm suppressions that affect the specified alarm, including suppressions that target the corresponding compartment or tenancy. When false, lists only the alarm suppressions that target the specified alarm.

        Default is false.

      • getSortBy

        public ListAlarmSuppressionsRequest.SortBy getSortBy()
        The field to use when sorting returned alarm suppressions.

        Only one sorting level is provided.

        Example: timeCreated

      • getSortOrder

        public ListAlarmSuppressionsRequest.SortOrder getSortOrder()
        The sort order to use when sorting returned alarm suppressions.

        Ascending (ASC) or descending (DESC).

        Example: ASC

      • getPage

        public String getPage()
        For list pagination.

        The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

      • getLimit

        public Integer getLimit()
        For list pagination.

        The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

        Default: 1000

        Example: 500

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>