Class DescribeAnomalyDetectorsRequest
- 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.DescribeAnomalyDetectorsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAnomalyDetectorsRequest.Builder,DescribeAnomalyDetectorsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAnomalyDetectorsRequest extends CloudWatchRequest implements ToCopyableBuilder<DescribeAnomalyDetectorsRequest.Builder,DescribeAnomalyDetectorsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeAnomalyDetectorsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AnomalyDetectorType>
anomalyDetectorTypes()
The anomaly detector types to request when usingDescribeAnomalyDetectorsInput
.List<String>
anomalyDetectorTypesAsStrings()
The anomaly detector types to request when usingDescribeAnomalyDetectorsInput
.static DescribeAnomalyDetectorsRequest.Builder
builder()
List<Dimension>
dimensions()
Limits the results to only the anomaly detection models that are associated with the specified metric dimensions.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAnomalyDetectorTypes()
For responses, this returns true if the service returned a value for the AnomalyDetectorTypes property.boolean
hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property.int
hashCode()
Integer
maxResults()
The maximum number of results to return in one operation.String
metricName()
Limits the results to only the anomaly detection models that are associated with the specified metric name.String
namespace()
Limits the results to only the anomaly detection models that are associated with the specified namespace.String
nextToken()
Use the token returned by the previous operation to request the next page of results.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeAnomalyDetectorsRequest.Builder>
serializableBuilderClass()
DescribeAnomalyDetectorsRequest.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
-
nextToken
public final String nextToken()
Use the token returned by the previous operation to request the next page of results.
- Returns:
- Use the token returned by the previous operation to request the next page of results.
-
maxResults
public final Integer maxResults()
The maximum number of results to return in one operation. The maximum value that you can specify is 100.
To retrieve the remaining results, make another call with the returned
NextToken
value.- Returns:
- The maximum number of results to return in one operation. The maximum value that you can specify is
100.
To retrieve the remaining results, make another call with the returned
NextToken
value.
-
namespace
public final String namespace()
Limits the results to only the anomaly detection models that are associated with the specified namespace.
- Returns:
- Limits the results to only the anomaly detection models that are associated with the specified namespace.
-
metricName
public final String metricName()
Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.
- Returns:
- Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all 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 theisEmpty()
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<Dimension> dimensions()
Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all 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:
- Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.
-
anomalyDetectorTypes
public final List<AnomalyDetectorType> anomalyDetectorTypes()
The anomaly detector types to request when using
DescribeAnomalyDetectorsInput
. If empty, defaults toSINGLE_METRIC
.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
hasAnomalyDetectorTypes()
method.- Returns:
- The anomaly detector types to request when using
DescribeAnomalyDetectorsInput
. If empty, defaults toSINGLE_METRIC
.
-
hasAnomalyDetectorTypes
public final boolean hasAnomalyDetectorTypes()
For responses, this returns true if the service returned a value for the AnomalyDetectorTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
anomalyDetectorTypesAsStrings
public final List<String> anomalyDetectorTypesAsStrings()
The anomaly detector types to request when using
DescribeAnomalyDetectorsInput
. If empty, defaults toSINGLE_METRIC
.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
hasAnomalyDetectorTypes()
method.- Returns:
- The anomaly detector types to request when using
DescribeAnomalyDetectorsInput
. If empty, defaults toSINGLE_METRIC
.
-
toBuilder
public DescribeAnomalyDetectorsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeAnomalyDetectorsRequest.Builder,DescribeAnomalyDetectorsRequest>
- Specified by:
toBuilder
in classCloudWatchRequest
-
builder
public static DescribeAnomalyDetectorsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeAnomalyDetectorsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-