java.lang.Object
- com.oracle.bmc.requests.BmcRequest<ListMetricsDetails>
- - com.oracle.bmc.monitoring.requests.ListMetricsRequest

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public class ListMetricsRequest
extends BmcRequest<ListMetricsDetails>
```
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/monitoring/ListMetricsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMetricsRequest.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ListMetricsRequest.Builder

Constructor Summary

Constructors
Constructor Description

ListMetricsRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListMetricsRequest.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’.
`ListMetricsDetails`	`getBody$()`	Alternative accessor for the body parameter.
`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.
`Integer`	`getLimit()`	For list pagination.
`ListMetricsDetails`	`getListMetricsDetails()`	The dimensions used to filter metrics.
`String`	`getOpcRequestId()`	Customer part of the request identifier token.
`String`	`getPage()`	For list pagination.
`int`	`hashCode()`	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListMetricsRequest.Builder`	`toBuilder()`	Return an instance of `ListMetricsRequest.Builder` that allows you to modify request properties.
`String`	`toString()`

Methods inherited from class com.oracle.bmc.requests.BmcRequest
getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListMetricsRequest
```
public ListMetricsRequest()
```
- 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
  - getListMetricsDetails
```
public ListMetricsDetails getListMetricsDetails()
```
    The dimensions used to filter metrics.
  - 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
  - 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.
  - getBody$
```
public ListMetricsDetails getBody$()
```
    Alternative accessor for the body parameter.
    
    Overrides:
    
    getBody$ in class BmcRequest<ListMetricsDetails>
    
    Returns:
    
    body parameter
  - toBuilder
```
public ListMetricsRequest.Builder toBuilder()
```
    Return an instance of ListMetricsRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListMetricsRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListMetricsRequest.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<ListMetricsDetails>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<ListMetricsDetails>

Class ListMetricsRequest

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListMetricsRequest

Method Detail

getCompartmentId

getListMetricsDetails

getOpcRequestId

getPage

getLimit

getCompartmentIdInSubtree

getBody$

toBuilder

builder

toString

equals

hashCode