software.amazon.awssdk.services.cloudwatch.model.PutAnomalyDetectorRequest 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.List;
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 PutAnomalyDetectorRequest extends CloudWatchRequest implements
ToCopyableBuilder {
private static final SdkField NAMESPACE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Namespace").getter(getter(PutAnomalyDetectorRequest::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(PutAnomalyDetectorRequest::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(PutAnomalyDetectorRequest::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 STAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Stat")
.getter(getter(PutAnomalyDetectorRequest::stat)).setter(setter(Builder::stat))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Stat").build()).build();
private static final SdkField CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Configuration")
.getter(getter(PutAnomalyDetectorRequest::configuration)).setter(setter(Builder::configuration))
.constructor(AnomalyDetectorConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Configuration").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAMESPACE_FIELD,
METRIC_NAME_FIELD, DIMENSIONS_FIELD, STAT_FIELD, CONFIGURATION_FIELD));
private final String namespace;
private final String metricName;
private final List dimensions;
private final String stat;
private final AnomalyDetectorConfiguration configuration;
private PutAnomalyDetectorRequest(BuilderImpl builder) {
super(builder);
this.namespace = builder.namespace;
this.metricName = builder.metricName;
this.dimensions = builder.dimensions;
this.stat = builder.stat;
this.configuration = builder.configuration;
}
/**
*
* The namespace of the metric to create the anomaly detection model for.
*
*
* @return The namespace of the metric to create the anomaly detection model for.
*/
public final String namespace() {
return namespace;
}
/**
*
* The name of the metric to create the anomaly detection model for.
*
*
* @return The name of the metric to create the anomaly detection model for.
*/
public final String metricName() {
return metricName;
}
/**
* Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasDimensions() {
return dimensions != null && !(dimensions instanceof SdkAutoConstructList);
}
/**
*
* The metric dimensions to create the anomaly detection model for.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasDimensions()} to see if a value was sent in this field.
*
*
* @return The metric dimensions to create the anomaly detection model for.
*/
public final List dimensions() {
return dimensions;
}
/**
*
* The statistic to use for the metric and the anomaly detection model.
*
*
* @return The statistic to use for the metric and the anomaly detection model.
*/
public final String stat() {
return stat;
}
/**
*
* The configuration specifies details about how the anomaly detection model is to be trained, including time ranges
* to exclude when training and updating the model. You can specify as many as 10 time ranges.
*
*
* The configuration can also include the time zone to use for the metric.
*
*
* @return The configuration specifies details about how the anomaly detection model is to be trained, including
* time ranges to exclude when training and updating the model. You can specify as many as 10 time
* ranges.
*
* The configuration can also include the time zone to use for the metric.
*/
public final AnomalyDetectorConfiguration configuration() {
return configuration;
}
@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(namespace());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(hasDimensions() ? dimensions() : null);
hashCode = 31 * hashCode + Objects.hashCode(stat());
hashCode = 31 * hashCode + Objects.hashCode(configuration());
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 PutAnomalyDetectorRequest)) {
return false;
}
PutAnomalyDetectorRequest other = (PutAnomalyDetectorRequest) obj;
return Objects.equals(namespace(), other.namespace()) && Objects.equals(metricName(), other.metricName())
&& hasDimensions() == other.hasDimensions() && Objects.equals(dimensions(), other.dimensions())
&& Objects.equals(stat(), other.stat()) && Objects.equals(configuration(), other.configuration());
}
/**
* 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("PutAnomalyDetectorRequest").add("Namespace", namespace()).add("MetricName", metricName())
.add("Dimensions", hasDimensions() ? dimensions() : null).add("Stat", stat())
.add("Configuration", configuration()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
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 "Stat":
return Optional.ofNullable(clazz.cast(stat()));
case "Configuration":
return Optional.ofNullable(clazz.cast(configuration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutAnomalyDetectorRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The namespace of the metric to create the anomaly detection model for.
*
*
* @param namespace
* The namespace of the metric to create the anomaly detection model for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder namespace(String namespace);
/**
*
* The name of the metric to create the anomaly detection model for.
*
*
* @param metricName
* The name of the metric to create the anomaly detection model for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The metric dimensions to create the anomaly detection model for.
*
*
* @param dimensions
* The metric dimensions to create the anomaly detection model for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(Collection dimensions);
/**
*
* The metric dimensions to create the anomaly detection model for.
*
*
* @param dimensions
* The metric dimensions to create the anomaly detection model for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(Dimension... dimensions);
/**
*
* The metric dimensions to create the anomaly detection model for.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #dimensions(List)}.
*
* @param dimensions
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensions(List)
*/
Builder dimensions(Consumer... dimensions);
/**
*
* The statistic to use for the metric and the anomaly detection model.
*
*
* @param stat
* The statistic to use for the metric and the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stat(String stat);
/**
*
* The configuration specifies details about how the anomaly detection model is to be trained, including time
* ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.
*
*
* The configuration can also include the time zone to use for the metric.
*
*
* @param configuration
* The configuration specifies details about how the anomaly detection model is to be trained, including
* time ranges to exclude when training and updating the model. You can specify as many as 10 time
* ranges.
*
* The configuration can also include the time zone to use for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configuration(AnomalyDetectorConfiguration configuration);
/**
*
* The configuration specifies details about how the anomaly detection model is to be trained, including time
* ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.
*
*
* The configuration can also include the time zone to use for the metric.
*
* This is a convenience that creates an instance of the {@link AnomalyDetectorConfiguration.Builder} avoiding
* the need to create one manually via {@link AnomalyDetectorConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link AnomalyDetectorConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #configuration(AnomalyDetectorConfiguration)}.
*
* @param configuration
* a consumer that will call methods on {@link AnomalyDetectorConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #configuration(AnomalyDetectorConfiguration)
*/
default Builder configuration(Consumer configuration) {
return configuration(AnomalyDetectorConfiguration.builder().applyMutation(configuration).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudWatchRequest.BuilderImpl implements Builder {
private String namespace;
private String metricName;
private List dimensions = DefaultSdkAutoConstructList.getInstance();
private String stat;
private AnomalyDetectorConfiguration configuration;
private BuilderImpl() {
}
private BuilderImpl(PutAnomalyDetectorRequest model) {
super(model);
namespace(model.namespace);
metricName(model.metricName);
dimensions(model.dimensions);
stat(model.stat);
configuration(model.configuration);
}
public final String getNamespace() {
return namespace;
}
@Override
public final Builder namespace(String namespace) {
this.namespace = namespace;
return this;
}
public final void setNamespace(String namespace) {
this.namespace = namespace;
}
public final String getMetricName() {
return metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
public final Collection getDimensions() {
if (dimensions instanceof SdkAutoConstructList) {
return null;
}
return dimensions != null ? dimensions.stream().map(Dimension::toBuilder).collect(Collectors.toList()) : null;
}
@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 void setDimensions(Collection dimensions) {
this.dimensions = DimensionsCopier.copyFromBuilder(dimensions);
}
public final String getStat() {
return stat;
}
@Override
public final Builder stat(String stat) {
this.stat = stat;
return this;
}
public final void setStat(String stat) {
this.stat = stat;
}
public final AnomalyDetectorConfiguration.Builder getConfiguration() {
return configuration != null ? configuration.toBuilder() : null;
}
@Override
public final Builder configuration(AnomalyDetectorConfiguration configuration) {
this.configuration = configuration;
return this;
}
public final void setConfiguration(AnomalyDetectorConfiguration.BuilderImpl configuration) {
this.configuration = configuration != null ? configuration.build() : null;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutAnomalyDetectorRequest build() {
return new PutAnomalyDetectorRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}