java.lang.Object
- com.oracle.bmc.monitoring.requests.ListAlarmsStatusRequest.Builder

All Implemented Interfaces:: BmcRequest.Builder<ListAlarmsStatusRequest,Void>

Enclosing class:: ListAlarmsStatusRequest

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

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

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

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 ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.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
  - compartmentIdInSubtree
```
public ListAlarmsStatusRequest.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
  - page
```
public ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.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
  - sortBy
```
public ListAlarmsStatusRequest.Builder sortBy(ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.Builder sortOrder(ListAlarmsStatusRequest.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
  - resourceId
```
public ListAlarmsStatusRequest.Builder resourceId(String resourceId)
```
    A filter to return only the resource with the specified OCID.
    The resource must be monitored by the metric that you are searching for.
    
    Example: ocid1.instance.oc1.phx.exampleuniqueID
    
    Parameters:
    
    resourceId - the value to set
    
    Returns:
    
    this builder instance
  - serviceName
```
public ListAlarmsStatusRequest.Builder serviceName(String serviceName)
```
    A filter to return only resources that match the given service name exactly.
    Use this filter to list all alarms containing metric streams that match the exact service-name dimension.
    
    Example: logging-analytics
    
    Parameters:
    
    serviceName - the value to set
    
    Returns:
    
    this builder instance
  - entityId
```
public ListAlarmsStatusRequest.Builder entityId(String entityId)
```
    A filter to return only resources that match the given entity OCID exactly.
    The resource (entity) must be monitored by the metric that you are searching for.
    
    Example: ocid1.instance.oc1.phx.exampleuniqueID
    
    Parameters:
    
    entityId - the value to set
    
    Returns:
    
    this builder instance
  - status
```
public ListAlarmsStatusRequest.Builder status(ListAlarmsStatusRequest.Status status)
```
    A filter to return only metric streams that match the specified status.
    For example, the value “FIRING” returns only firing metric streams.
    
    Example: FIRING
    
    Parameters:
    
    status - the value to set
    
    Returns:
    
    this builder instance
  - invocationCallback
```
public ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.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 ListAlarmsStatusRequest.Builder copy(ListAlarmsStatusRequest o)
```
    Copy method to populate the builder with values from the given instance.
    
    Specified by:
    
    copy in interface BmcRequest.Builder<ListAlarmsStatusRequest,Void>
    
    Parameters:
    
    o - other request from which to copy values
    
    Returns:
    
    this builder instance
  - build
```
public ListAlarmsStatusRequest build()
```
    Build the instance of ListAlarmsStatusRequest 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<ListAlarmsStatusRequest,Void>
    
    Returns:
    
    instance of ListAlarmsStatusRequest
  - buildWithoutInvocationCallback
```
public ListAlarmsStatusRequest buildWithoutInvocationCallback()
```
    Build the instance of ListAlarmsStatusRequest 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 ListAlarmsStatusRequest

Class ListAlarmsStatusRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

Constructor Detail

Builder

Method Detail

compartmentId

opcRequestId

compartmentIdInSubtree

page

limit

displayName

sortBy

sortOrder

resourceId

serviceName

entityId

status

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback