com.oracle.bmc.monitoring.requests

Class ListAlarmsRequest

java.lang.Object

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

com.oracle.bmc.monitoring.requests.ListAlarmsRequest

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

Example: Click here to see how to use ListAlarmsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAlarmsRequest.Builder
static class	ListAlarmsRequest.SortBy The field to use when sorting returned alarm definitions.
static class	ListAlarmsRequest.SortOrder The sort order to use when sorting returned alarm definitions.

Constructor Summary

Constructors

Constructor and Description
ListAlarmsRequest()

Method Summary

Modifier and Type	Method and Description
static ListAlarmsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The OCID of the compartment containing the resources monitored by the metric that you are searching for.
Boolean	getCompartmentIdInSubtree() When true, returns resources from all compartments and subcompartments.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
Alarm.LifecycleState	getLifecycleState() A filter to return only alarms that match the given lifecycle state exactly.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Customer part of the request identifier token.
String	getPage() For list pagination.
ListAlarmsRequest.SortBy	getSortBy() The field to use when sorting returned alarm definitions.
ListAlarmsRequest.SortOrder	getSortOrder() The sort order to use when sorting returned alarm definitions.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListAlarmsRequest.Builder	toBuilder() Return an instance of ListAlarmsRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.

toBuilder

public ListAlarmsRequest.Builder toBuilder()

Return an instance of ListAlarmsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListAlarmsRequest.Builder that allows you to modify request properties.

builder

public static ListAlarmsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class 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>