com.oracle.bmc.monitoring.requests

Class GetAlarmHistoryRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.monitoring.requests.GetAlarmHistoryRequest

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

Example: Click here to see how to use GetAlarmHistoryRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetAlarmHistoryRequest.AlarmHistorytype The type of history entries to retrieve.
static class	GetAlarmHistoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetAlarmHistoryRequest.Builder	builder()
GetAlarmHistoryRequest.AlarmHistorytype	getAlarmHistorytype() The type of history entries to retrieve.
String	getAlarmId() The OCID of an alarm.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Customer part of the request identifier token.
String	getPage() For list pagination.
Date	getTimestampGreaterThanOrEqualTo() A filter to return only alarm history entries with timestamps occurring on or after the specified date and time.
Date	getTimestampLessThan() A filter to return only alarm history entries with timestamps occurring before the specified date and time.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static GetAlarmHistoryRequest.Builder builder()

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) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both 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: `2019-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: `2019-01-02T01:00:00.789Z`