software.amazon.awssdk.services.cloudwatch.model.DescribeAnomalyDetectorsRequest Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudwatch.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeAnomalyDetectorsRequest extends CloudWatchRequest implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeAnomalyDetectorsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeAnomalyDetectorsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NAMESPACE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Namespace").getter(getter(DescribeAnomalyDetectorsRequest::namespace))
.setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Namespace").build()).build();
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MetricName").getter(getter(DescribeAnomalyDetectorsRequest::metricName))
.setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField> DIMENSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Dimensions")
.getter(getter(DescribeAnomalyDetectorsRequest::dimensions))
.setter(setter(Builder::dimensions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Dimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ANOMALY_DETECTOR_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AnomalyDetectorTypes")
.getter(getter(DescribeAnomalyDetectorsRequest::anomalyDetectorTypesAsStrings))
.setter(setter(Builder::anomalyDetectorTypesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AnomalyDetectorTypes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD, NAMESPACE_FIELD, METRIC_NAME_FIELD, DIMENSIONS_FIELD, ANOMALY_DETECTOR_TYPES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("NextToken", NEXT_TOKEN_FIELD);
put("MaxResults", MAX_RESULTS_FIELD);
put("Namespace", NAMESPACE_FIELD);
put("MetricName", METRIC_NAME_FIELD);
put("Dimensions", DIMENSIONS_FIELD);
put("AnomalyDetectorTypes", ANOMALY_DETECTOR_TYPES_FIELD);
}
});
private final String nextToken;
private final Integer maxResults;
private final String namespace;
private final String metricName;
private final List dimensions;
private final List anomalyDetectorTypes;
private DescribeAnomalyDetectorsRequest(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.namespace = builder.namespace;
this.metricName = builder.metricName;
this.dimensions = builder.dimensions;
this.anomalyDetectorTypes = builder.anomalyDetectorTypes;
}
/**
*
* Use the token returned by the previous operation to request the next page of results.
*
*
* @return Use the token returned by the previous operation to request the next page of results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Limits the results to only the anomaly detection models that are associated with the specified namespace.
*
*
* @return Limits the results to only the anomaly detection models that are associated with the specified namespace.
*/
public final String namespace() {
return namespace;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String metricName() {
return metricName;
}
/**
* 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 {@code 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 boolean hasDimensions() {
return dimensions != null && !(dimensions instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasDimensions} method.
*
*
* @return 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.
*/
public final List dimensions() {
return dimensions;
}
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults
* to SINGLE_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 {@link #hasAnomalyDetectorTypes} method.
*
*
* @return The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*/
public final List anomalyDetectorTypes() {
return AnomalyDetectorTypesCopier.copyStringToEnum(anomalyDetectorTypes);
}
/**
* 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 the {@code 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 boolean hasAnomalyDetectorTypes() {
return anomalyDetectorTypes != null && !(anomalyDetectorTypes instanceof SdkAutoConstructList);
}
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults
* to SINGLE_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 {@link #hasAnomalyDetectorTypes} method.
*
*
* @return The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*/
public final List anomalyDetectorTypesAsStrings() {
return anomalyDetectorTypes;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(hasDimensions() ? dimensions() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAnomalyDetectorTypes() ? anomalyDetectorTypesAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeAnomalyDetectorsRequest)) {
return false;
}
DescribeAnomalyDetectorsRequest other = (DescribeAnomalyDetectorsRequest) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(namespace(), other.namespace()) && Objects.equals(metricName(), other.metricName())
&& hasDimensions() == other.hasDimensions() && Objects.equals(dimensions(), other.dimensions())
&& hasAnomalyDetectorTypes() == other.hasAnomalyDetectorTypes()
&& Objects.equals(anomalyDetectorTypesAsStrings(), other.anomalyDetectorTypesAsStrings());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeAnomalyDetectorsRequest").add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("Namespace", namespace()).add("MetricName", metricName())
.add("Dimensions", hasDimensions() ? dimensions() : null)
.add("AnomalyDetectorTypes", hasAnomalyDetectorTypes() ? anomalyDetectorTypesAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "Namespace":
return Optional.ofNullable(clazz.cast(namespace()));
case "MetricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "AnomalyDetectorTypes":
return Optional.ofNullable(clazz.cast(anomalyDetectorTypesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeAnomalyDetectorsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Use the token returned by the previous operation to request the next page of results.
*
*
* @param nextToken
* Use the token returned by the previous operation to request the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Limits the results to only the anomaly detection models that are associated with the specified namespace.
*
*
* @param namespace
* Limits the results to only the anomaly detection models that are associated with the specified
* namespace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder namespace(String namespace);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(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.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudwatch.model.Dimension.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.cloudwatch.model.Dimension#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudwatch.model.Dimension.Builder#build()} is called immediately and
* its result is passed to {@link #dimensions(List)}.
*
* @param dimensions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.Dimension.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensions(java.util.Collection)
*/
Builder dimensions(Consumer... dimensions);
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*
*
* @param anomalyDetectorTypes
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder anomalyDetectorTypesWithStrings(Collection anomalyDetectorTypes);
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*
*
* @param anomalyDetectorTypes
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder anomalyDetectorTypesWithStrings(String... anomalyDetectorTypes);
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*
*
* @param anomalyDetectorTypes
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder anomalyDetectorTypes(Collection anomalyDetectorTypes);
/**
*
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
*
*
* @param anomalyDetectorTypes
* The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty,
* defaults to SINGLE_METRIC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder anomalyDetectorTypes(AnomalyDetectorType... anomalyDetectorTypes);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudWatchRequest.BuilderImpl implements Builder {
private String nextToken;
private Integer maxResults;
private String namespace;
private String metricName;
private List dimensions = DefaultSdkAutoConstructList.getInstance();
private List anomalyDetectorTypes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeAnomalyDetectorsRequest model) {
super(model);
nextToken(model.nextToken);
maxResults(model.maxResults);
namespace(model.namespace);
metricName(model.metricName);
dimensions(model.dimensions);
anomalyDetectorTypesWithStrings(model.anomalyDetectorTypes);
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNamespace() {
return namespace;
}
public final void setNamespace(String namespace) {
this.namespace = namespace;
}
@Override
public final Builder namespace(String namespace) {
this.namespace = namespace;
return this;
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final List getDimensions() {
List result = DimensionsCopier.copyToBuilder(this.dimensions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDimensions(Collection dimensions) {
this.dimensions = DimensionsCopier.copyFromBuilder(dimensions);
}
@Override
public final Builder dimensions(Collection dimensions) {
this.dimensions = DimensionsCopier.copy(dimensions);
return this;
}
@Override
@SafeVarargs
public final Builder dimensions(Dimension... dimensions) {
dimensions(Arrays.asList(dimensions));
return this;
}
@Override
@SafeVarargs
public final Builder dimensions(Consumer... dimensions) {
dimensions(Stream.of(dimensions).map(c -> Dimension.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Collection getAnomalyDetectorTypes() {
if (anomalyDetectorTypes instanceof SdkAutoConstructList) {
return null;
}
return anomalyDetectorTypes;
}
public final void setAnomalyDetectorTypes(Collection anomalyDetectorTypes) {
this.anomalyDetectorTypes = AnomalyDetectorTypesCopier.copy(anomalyDetectorTypes);
}
@Override
public final Builder anomalyDetectorTypesWithStrings(Collection anomalyDetectorTypes) {
this.anomalyDetectorTypes = AnomalyDetectorTypesCopier.copy(anomalyDetectorTypes);
return this;
}
@Override
@SafeVarargs
public final Builder anomalyDetectorTypesWithStrings(String... anomalyDetectorTypes) {
anomalyDetectorTypesWithStrings(Arrays.asList(anomalyDetectorTypes));
return this;
}
@Override
public final Builder anomalyDetectorTypes(Collection anomalyDetectorTypes) {
this.anomalyDetectorTypes = AnomalyDetectorTypesCopier.copyEnumToString(anomalyDetectorTypes);
return this;
}
@Override
@SafeVarargs
public final Builder anomalyDetectorTypes(AnomalyDetectorType... anomalyDetectorTypes) {
anomalyDetectorTypes(Arrays.asList(anomalyDetectorTypes));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeAnomalyDetectorsRequest build() {
return new DescribeAnomalyDetectorsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}