public static class ListAlarmsRequest.Builder extends Object implements BmcRequest.Builder<ListAlarmsRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
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
compartmentId
- the value to setpublic 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.
opcRequestId
- the value to setpublic 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.
page
- the value to setpublic 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
limit
- the value to setpublic 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.
displayName
- the value to setpublic 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.
lifecycleState
- the value to setpublic ListAlarmsRequest.Builder sortBy(ListAlarmsRequest.SortBy sortBy)
The field to use when sorting returned alarm definitions. Only one sorting level is provided.
Example: severity
sortBy
- the value to setpublic ListAlarmsRequest.Builder sortOrder(ListAlarmsRequest.SortOrder sortOrder)
The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).
Example: ASC
sortOrder
- the value to setpublic 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.
compartmentIdInSubtree
- the value to setpublic ListAlarmsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListAlarmsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListAlarmsRequest.Builder copy(ListAlarmsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListAlarmsRequest,Void>
o
- other request from which to copy valuespublic 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.
build
in interface BmcRequest.Builder<ListAlarmsRequest,Void>
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
Copyright © 2016–2024. All rights reserved.