com.oracle.bmc.monitoring.requests

Class ListAlarmSuppressionsRequest

java.lang.Object

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

com.oracle.bmc.monitoring.requests.ListAlarmSuppressionsRequest

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

Example: Click here to see how to use ListAlarmSuppressionsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAlarmSuppressionsRequest.Builder
static class	ListAlarmSuppressionsRequest.SortBy The field to use when sorting returned alarm suppressions.
static class	ListAlarmSuppressionsRequest.SortOrder The sort order to use when sorting returned alarm suppressions.
static class	ListAlarmSuppressionsRequest.TargetType The target type to use when listing alarm suppressions.

Constructor Summary

Constructors

Constructor and Description
ListAlarmSuppressionsRequest()

Method Summary

Modifier and Type	Method and Description
static ListAlarmSuppressionsRequest.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	getAlarmId() The OCID of the alarm that is the target of the alarm suppression.
String	getCompartmentId() The OCID of the compartment for searching.
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.
Boolean	getIsAllSuppressions() Setting this parameter to true requires the query to specify the alarm (alarmId).
AlarmSuppression.Level	getLevel() The level of this alarm suppression.
AlarmSuppression.LifecycleState	getLifecycleState() A filter to return only resources 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.
ListAlarmSuppressionsRequest.SortBy	getSortBy() The field to use when sorting returned alarm suppressions.
ListAlarmSuppressionsRequest.SortOrder	getSortOrder() The sort order to use when sorting returned alarm suppressions.
ListAlarmSuppressionsRequest.TargetType	getTargetType() The target type to use when listing alarm suppressions.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListAlarmSuppressionsRequest.Builder	toBuilder() Return an instance of ListAlarmSuppressionsRequest.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

ListAlarmSuppressionsRequest

public ListAlarmSuppressionsRequest()

Method Detail

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.

getAlarmId

public String getAlarmId()

The OCID of the alarm that is the target of the alarm suppression.

getDisplayName

public String getDisplayName()

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.

getLifecycleState

public AlarmSuppression.LifecycleState getLifecycleState()

A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.

getLevel

public AlarmSuppression.Level getLevel()

The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for searching. Use the tenancy OCID to search in the root compartment.

If targetType is not specified, searches all suppressions defined under the compartment. If targetType is COMPARTMENT, searches suppressions in the specified compartment only.

Example: ocid1.compartment.oc1..exampleuniqueID

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.

getTargetType

public ListAlarmSuppressionsRequest.TargetType getTargetType()

The target type to use when listing alarm suppressions. ALARM lists all suppression records for the specified alarm. COMPARTMENT lists all suppression records for the specified compartment or tenancy.

getIsAllSuppressions

public Boolean getIsAllSuppressions()

Setting this parameter to true requires the query to specify the alarm (alarmId).

When true, lists all alarm suppressions that affect the specified alarm, including suppressions that target the corresponding compartment or tenancy. When false, lists only the alarm suppressions that target the specified alarm.

Default is false.

getSortBy

public ListAlarmSuppressionsRequest.SortBy getSortBy()

The field to use when sorting returned alarm suppressions. Only one sorting level is provided.

Example: timeCreated

getSortOrder

public ListAlarmSuppressionsRequest.SortOrder getSortOrder()

The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC).

Example: ASC

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

toBuilder

public ListAlarmSuppressionsRequest.Builder toBuilder()

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

Returns:

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

builder

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