com.oracle.bmc.monitoring.requests

Class ListAlarmSuppressionsRequest.Builder

java.lang.Object

com.oracle.bmc.monitoring.requests.ListAlarmSuppressionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAlarmSuppressionsRequest,Void>

Enclosing class:

ListAlarmSuppressionsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListAlarmSuppressionsRequest.Builder	alarmId(String alarmId) The OCID of the alarm that is the target of the alarm suppression.
ListAlarmSuppressionsRequest	build() Build the instance of ListAlarmSuppressionsRequest as configured by this builder
ListAlarmSuppressionsRequest	buildWithoutInvocationCallback() Build the instance of ListAlarmSuppressionsRequest as configured by this builder
ListAlarmSuppressionsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment for searching.
ListAlarmSuppressionsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) When true, returns resources from all compartments and subcompartments.
ListAlarmSuppressionsRequest.Builder	copy(ListAlarmSuppressionsRequest o) Copy method to populate the builder with values from the given instance.
ListAlarmSuppressionsRequest.Builder	displayName(String displayName) A filter to return only resources that match the given display name exactly.
ListAlarmSuppressionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListAlarmSuppressionsRequest.Builder	isAllSuppressions(Boolean isAllSuppressions) Setting this parameter to true requires the query to specify the alarm (alarmId).
ListAlarmSuppressionsRequest.Builder	level(AlarmSuppression.Level level) The level of this alarm suppression.
ListAlarmSuppressionsRequest.Builder	lifecycleState(AlarmSuppression.LifecycleState lifecycleState) A filter to return only resources that match the given lifecycle state exactly.
ListAlarmSuppressionsRequest.Builder	limit(Integer limit) For list pagination.
ListAlarmSuppressionsRequest.Builder	opcRequestId(String opcRequestId) Customer part of the request identifier token.
ListAlarmSuppressionsRequest.Builder	page(String page) For list pagination.
ListAlarmSuppressionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListAlarmSuppressionsRequest.Builder	sortBy(ListAlarmSuppressionsRequest.SortBy sortBy) The field to use when sorting returned alarm suppressions.
ListAlarmSuppressionsRequest.Builder	sortOrder(ListAlarmSuppressionsRequest.SortOrder sortOrder) The sort order to use when sorting returned alarm suppressions.
ListAlarmSuppressionsRequest.Builder	targetType(ListAlarmSuppressionsRequest.TargetType targetType) The target type to use when listing alarm suppressions.

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

opcRequestId

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

alarmId

public ListAlarmSuppressionsRequest.Builder alarmId(String alarmId)

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

Parameters:

alarmId - the value to set

Returns:

this builder instance

displayName

public ListAlarmSuppressionsRequest.Builder displayName(String displayName)

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.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListAlarmSuppressionsRequest.Builder lifecycleState(AlarmSuppression.LifecycleState lifecycleState)

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.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

level

public ListAlarmSuppressionsRequest.Builder level(AlarmSuppression.Level level)

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.

Parameters:

level - the value to set

Returns:

this builder instance

compartmentId

public ListAlarmSuppressionsRequest.Builder compartmentId(String compartmentId)

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

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

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

targetType

public ListAlarmSuppressionsRequest.Builder targetType(ListAlarmSuppressionsRequest.TargetType targetType)

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.

Parameters:

targetType - the value to set

Returns:

this builder instance

isAllSuppressions

public ListAlarmSuppressionsRequest.Builder isAllSuppressions(Boolean isAllSuppressions)

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.

Parameters:

isAllSuppressions - the value to set

Returns:

this builder instance

sortBy

public ListAlarmSuppressionsRequest.Builder sortBy(ListAlarmSuppressionsRequest.SortBy sortBy)

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

Example: timeCreated

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListAlarmSuppressionsRequest.Builder sortOrder(ListAlarmSuppressionsRequest.SortOrder sortOrder)

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

Example: ASC

Parameters:

sortOrder - the value to set

Returns:

this builder instance

page

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListAlarmSuppressionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAlarmSuppressionsRequest build()

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

Returns:

instance of ListAlarmSuppressionsRequest

buildWithoutInvocationCallback

public ListAlarmSuppressionsRequest buildWithoutInvocationCallback()

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