Package com.oracle.bmc.monitoring.requests

Class ListAlarmsRequest.Builder

java.lang.Object

com.oracle.bmc.monitoring.requests.ListAlarmsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAlarmsRequest,Void>

Enclosing class:

ListAlarmsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListAlarmsRequest	build()	Build the instance of ListAlarmsRequest as configured by this builder
ListAlarmsRequest	buildWithoutInvocationCallback()	Build the instance of ListAlarmsRequest as configured by this builder
ListAlarmsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment containing the resources monitored by the metric that you are searching for.
ListAlarmsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	When true, returns resources from all compartments and subcompartments.
ListAlarmsRequest.Builder	copy(ListAlarmsRequest o)	Copy method to populate the builder with values from the given instance.
ListAlarmsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListAlarmsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListAlarmsRequest.Builder	lifecycleState(Alarm.LifecycleState lifecycleState)	A filter to return only alarms that match the given lifecycle state exactly.
ListAlarmsRequest.Builder	limit(Integer limit)	For list pagination.
ListAlarmsRequest.Builder	opcRequestId(String opcRequestId)	Customer part of the request identifier token.
ListAlarmsRequest.Builder	page(String page)	For list pagination.
ListAlarmsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListAlarmsRequest.Builder	sortBy(ListAlarmsRequest.SortBy sortBy)	The field to use when sorting returned alarm definitions.
ListAlarmsRequest.Builder	sortOrder(ListAlarmsRequest.SortOrder sortOrder)	The sort order to use when sorting returned alarm definitions.

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

compartmentId

public ListAlarmsRequest.Builder compartmentId(String compartmentId)

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

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListAlarmsRequest.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

page

public ListAlarmsRequest.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 ListAlarmsRequest.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

displayName

public ListAlarmsRequest.Builder displayName(String displayName)

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.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListAlarmsRequest.Builder lifecycleState(Alarm.LifecycleState lifecycleState)

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.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortBy

public ListAlarmsRequest.Builder sortBy(ListAlarmsRequest.SortBy sortBy)

The field to use when sorting returned alarm definitions.

Only one sorting level is provided.

Example: severity

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListAlarmsRequest.Builder sortOrder(ListAlarmsRequest.SortOrder sortOrder)

The sort order to use when sorting returned alarm definitions.

Ascending (ASC) or descending (DESC).

Example: ASC

Parameters:

sortOrder - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListAlarmsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

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.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

invocationCallback

public ListAlarmsRequest.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 ListAlarmsRequest.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 ListAlarmsRequest.Builder copy(ListAlarmsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListAlarmsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAlarmsRequest build()

Build the instance of ListAlarmsRequest 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<ListAlarmsRequest,Void>

Returns:

instance of ListAlarmsRequest

buildWithoutInvocationCallback

public ListAlarmsRequest buildWithoutInvocationCallback()

Build the instance of ListAlarmsRequest 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 ListAlarmsRequest