Class GetAlarmHistoryRequest


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

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

    • Constructor Detail

      • GetAlarmHistoryRequest

        public GetAlarmHistoryRequest()
    • Method Detail

      • getAlarmId

        public String getAlarmId()
        The OCID of an alarm.
      • 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.

      • getAlarmHistorytype

        public GetAlarmHistoryRequest.AlarmHistorytype getAlarmHistorytype()
        The type of history entries to retrieve.

        State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY). If not specified, entries of all types are retrieved.

        Example: STATE_HISTORY

      • 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

      • getTimestampGreaterThanOrEqualTo

        public Date getTimestampGreaterThanOrEqualTo()
        A filter to return only alarm history entries with timestamps occurring on or after the specified date and time.

        Format defined by RFC3339.

        Example: 2023-01-01T01:00:00.789Z

      • getTimestampLessThan

        public Date getTimestampLessThan()
        A filter to return only alarm history entries with timestamps occurring before the specified date and time.

        Format defined by RFC3339.

        Example: 2023-01-02T01:00:00.789Z

      • builder

        public static GetAlarmHistoryRequest.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>