com.oracle.bmc.monitoring.requests

Class GetAlarmHistoryRequest.Builder

java.lang.Object

com.oracle.bmc.monitoring.requests.GetAlarmHistoryRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<GetAlarmHistoryRequest,Void>

Enclosing class:

GetAlarmHistoryRequest

public static class GetAlarmHistoryRequest.Builder
extends Object
implements BmcRequest.Builder<GetAlarmHistoryRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GetAlarmHistoryRequest.Builder	alarmHistorytype(GetAlarmHistoryRequest.AlarmHistorytype alarmHistorytype) The type of history entries to retrieve.
GetAlarmHistoryRequest.Builder	alarmId(String alarmId) The OCID of an alarm.
GetAlarmHistoryRequest	build() Build the instance of GetAlarmHistoryRequest as configured by this builder
GetAlarmHistoryRequest	buildWithoutInvocationCallback() Build the instance of GetAlarmHistoryRequest as configured by this builder
GetAlarmHistoryRequest.Builder	copy(GetAlarmHistoryRequest o) Copy method to populate the builder with values from the given instance.
GetAlarmHistoryRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
GetAlarmHistoryRequest.Builder	limit(Integer limit) For list pagination.
GetAlarmHistoryRequest.Builder	opcRequestId(String opcRequestId) Customer part of the request identifier token.
GetAlarmHistoryRequest.Builder	page(String page) For list pagination.
GetAlarmHistoryRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
GetAlarmHistoryRequest.Builder	timestampGreaterThanOrEqualTo(Date timestampGreaterThanOrEqualTo) A filter to return only alarm history entries with timestamps occurring on or after the specified date and time.
GetAlarmHistoryRequest.Builder	timestampLessThan(Date timestampLessThan) A filter to return only alarm history entries with timestamps occurring before the specified date and time.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

alarmId

public GetAlarmHistoryRequest.Builder alarmId(String alarmId)

The OCID of an alarm.

Parameters:

alarmId - the value to set

Returns:

this builder instance

opcRequestId

public GetAlarmHistoryRequest.Builder opcRequestId(String opcRequestId)

Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

alarmHistorytype

public GetAlarmHistoryRequest.Builder alarmHistorytype(GetAlarmHistoryRequest.AlarmHistorytype alarmHistorytype)

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

Parameters:

alarmHistorytype - the value to set

Returns:

this builder instance

page

public GetAlarmHistoryRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public GetAlarmHistoryRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

timestampGreaterThanOrEqualTo

public GetAlarmHistoryRequest.Builder timestampGreaterThanOrEqualTo(Date timestampGreaterThanOrEqualTo)

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

Parameters:

timestampGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timestampLessThan

public GetAlarmHistoryRequest.Builder timestampLessThan(Date timestampLessThan)

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

Parameters:

timestampLessThan - the value to set

Returns:

this builder instance

invocationCallback

public GetAlarmHistoryRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public GetAlarmHistoryRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public GetAlarmHistoryRequest.Builder copy(GetAlarmHistoryRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<GetAlarmHistoryRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public GetAlarmHistoryRequest build()

Build the instance of GetAlarmHistoryRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<GetAlarmHistoryRequest,Void>

Returns:

instance of GetAlarmHistoryRequest

buildWithoutInvocationCallback

public GetAlarmHistoryRequest buildWithoutInvocationCallback()

Build the instance of GetAlarmHistoryRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of GetAlarmHistoryRequest