@Generated(value="software.amazon.awssdk:codegen") public final class ListMetricsRequest extends CloudWatchRequest implements ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListMetricsRequest.Builder |
Modifier and Type | Method and 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() |
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.
|
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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String namespace()
The metric namespace to filter against. Only the namespace that matches exactly will be returned.
public final String metricName()
The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
public final boolean hasDimensions()
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.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.
public final String nextToken()
The token returned by a previous call to indicate that there is more data available.
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()
.
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.
RecentlyActive
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()
.
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.
RecentlyActive
public ListMetricsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>
toBuilder
in class CloudWatchRequest
public static ListMetricsRequest.Builder builder()
public static Class<? extends ListMetricsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.