java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
    - - software.amazon.awssdk.services.cloudwatch.model.ListMetricsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListMetricsRequest
extends CloudWatchRequest
implements ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListMetricsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListMetricsRequest.Builder`	`builder()`
`List<DimensionFilter>`	`dimensions()`	The dimensions to filter against.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDimensions()`	For responses, this returns true if the service returned a value for the Dimensions property.
`int`	`hashCode()`
`Boolean`	`includeLinkedAccounts()`	If you are using this operation in a monitoring account, specify `true` to include metrics from source accounts in the returned data.
`String`	`metricName()`	The name of the metric to filter against.
`String`	`namespace()`	The metric namespace to filter against.
`String`	`nextToken()`	The token returned by a previous call to indicate that there is more data available.
`String`	`owningAccount()`	When you use this operation in a monitoring account, use this field to return metrics only from one source account.
`RecentlyActive`	`recentlyActive()`	To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of `PT3H`.
`String`	`recentlyActiveAsString()`	To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of `PT3H`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListMetricsRequest.Builder>`	`serializableBuilderClass()`
`ListMetricsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - namespace
```
public final String namespace()
```
    The metric namespace to filter against. Only the namespace that matches exactly will be returned.
    
    Returns:
    
    The metric namespace to filter against. Only the namespace that matches exactly will be returned.
  - metricName
```
public final String metricName()
```
    The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
    
    Returns:
    
    The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
  - hasDimensions
```
public final boolean hasDimensions()
```
    For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dimensions
```
public final List<DimensionFilter> dimensions()
```
    The dimensions to filter against. Only the dimensions that match exactly will be returned.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.
    
    Returns:
    
    The dimensions to filter against. Only the dimensions that match exactly will be returned.
  - nextToken
```
public final String nextToken()
```
    The token returned by a previous call to indicate that there is more data available.
    
    Returns:
    
    The token returned by a previous call to indicate that there is more data available.
  - recentlyActive
```
public final RecentlyActive recentlyActive()
```
    To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.
    
    The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
    
    If the service returns an enum value that is not available in the current SDK version, recentlyActive will return RecentlyActive.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recentlyActiveAsString().
    
    Returns:
    
    To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.
    
    The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
    
    See Also:
    
    RecentlyActive
  - recentlyActiveAsString
```
public final String recentlyActiveAsString()
```
    To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.
    
    The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
    
    If the service returns an enum value that is not available in the current SDK version, recentlyActive will return RecentlyActive.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recentlyActiveAsString().
    
    Returns:
    
    To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.
    
    The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
    
    See Also:
    
    RecentlyActive
  - includeLinkedAccounts
```
public final Boolean includeLinkedAccounts()
```
    If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
    
    The default is false.
    
    Returns:
    
    If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
    
    The default is false.
  - owningAccount
```
public final String owningAccount()
```
    When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.
    
    Returns:
    
    When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.
  - toBuilder
```
public ListMetricsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchRequest
  - builder
```
public static ListMetricsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListMetricsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListMetricsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

namespace

metricName

hasDimensions

dimensions

nextToken

recentlyActive

recentlyActiveAsString

includeLinkedAccounts

owningAccount

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields