Package com.oracle.bmc.monitoring.requests

Class ListAlarmsRequest

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

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

    • Constructor Detail

      • ListAlarmsRequest

        public ListAlarmsRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the resources monitored by the metric that you are searching for.

        Use tenancyId to search in the root compartment.

        Example: ocid1.compartment.oc1..exampleuniqueID

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

      • 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

      • getDisplayName

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

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

      • getLifecycleState

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

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

      • getSortBy

        public ListAlarmsRequest.SortBy getSortBy()
        The field to use when sorting returned alarm definitions.

        Only one sorting level is provided.

        Example: severity

      • getSortOrder

        public ListAlarmsRequest.SortOrder getSortOrder()
        The sort order to use when sorting returned alarm definitions.

        Ascending (ASC) or descending (DESC).

        Example: ASC

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

      • builder

        public static ListAlarmsRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object

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