software.amazon.awssdk.services.lookoutmetrics.model.TimeSeries Maven / Gradle / Ivy
Show all versions of lookoutmetrics 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.lookoutmetrics.model;
import java.io.Serializable;
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.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;
/**
*
* Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as
* availability in the us-east-1 Region.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TimeSeries implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TIME_SERIES_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TimeSeriesId").getter(getter(TimeSeries::timeSeriesId)).setter(setter(Builder::timeSeriesId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeSeriesId").build()).build();
private static final SdkField> DIMENSION_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DimensionList")
.getter(getter(TimeSeries::dimensionList))
.setter(setter(Builder::dimensionList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DimensionList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DimensionNameValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> METRIC_VALUE_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MetricValueList")
.getter(getter(TimeSeries::metricValueList))
.setter(setter(Builder::metricValueList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricValueList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.DOUBLE)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TIME_SERIES_ID_FIELD,
DIMENSION_LIST_FIELD, METRIC_VALUE_LIST_FIELD));
private static final long serialVersionUID = 1L;
private final String timeSeriesId;
private final List dimensionList;
private final List metricValueList;
private TimeSeries(BuilderImpl builder) {
this.timeSeriesId = builder.timeSeriesId;
this.dimensionList = builder.dimensionList;
this.metricValueList = builder.metricValueList;
}
/**
*
* The ID of the metric.
*
*
* @return The ID of the metric.
*/
public final String timeSeriesId() {
return timeSeriesId;
}
/**
* For responses, this returns true if the service returned a value for the DimensionList 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 hasDimensionList() {
return dimensionList != null && !(dimensionList instanceof SdkAutoConstructList);
}
/**
*
* The dimensions of the 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 #hasDimensionList} method.
*
*
* @return The dimensions of the metric.
*/
public final List dimensionList() {
return dimensionList;
}
/**
* For responses, this returns true if the service returned a value for the MetricValueList 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 hasMetricValueList() {
return metricValueList != null && !(metricValueList instanceof SdkAutoConstructList);
}
/**
*
* The values for the 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 #hasMetricValueList} method.
*
*
* @return The values for the metric.
*/
public final List metricValueList() {
return metricValueList;
}
@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 + Objects.hashCode(timeSeriesId());
hashCode = 31 * hashCode + Objects.hashCode(hasDimensionList() ? dimensionList() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMetricValueList() ? metricValueList() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TimeSeries)) {
return false;
}
TimeSeries other = (TimeSeries) obj;
return Objects.equals(timeSeriesId(), other.timeSeriesId()) && hasDimensionList() == other.hasDimensionList()
&& Objects.equals(dimensionList(), other.dimensionList()) && hasMetricValueList() == other.hasMetricValueList()
&& Objects.equals(metricValueList(), other.metricValueList());
}
/**
* 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("TimeSeries").add("TimeSeriesId", timeSeriesId())
.add("DimensionList", hasDimensionList() ? dimensionList() : null)
.add("MetricValueList", hasMetricValueList() ? metricValueList() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TimeSeriesId":
return Optional.ofNullable(clazz.cast(timeSeriesId()));
case "DimensionList":
return Optional.ofNullable(clazz.cast(dimensionList()));
case "MetricValueList":
return Optional.ofNullable(clazz.cast(metricValueList()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TimeSeries) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the metric.
*
*
* @param timeSeriesId
* The ID of the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeSeriesId(String timeSeriesId);
/**
*
* The dimensions of the metric.
*
*
* @param dimensionList
* The dimensions of the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensionList(Collection dimensionList);
/**
*
* The dimensions of the metric.
*
*
* @param dimensionList
* The dimensions of the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensionList(DimensionNameValue... dimensionList);
/**
*
* The dimensions of the metric.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.lookoutmetrics.model.DimensionNameValue.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.lookoutmetrics.model.DimensionNameValue#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.lookoutmetrics.model.DimensionNameValue.Builder#build()} is called
* immediately and its result is passed to {@link #dimensionList(List)}.
*
* @param dimensionList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.lookoutmetrics.model.DimensionNameValue.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensionList(java.util.Collection)
*/
Builder dimensionList(Consumer... dimensionList);
/**
*
* The values for the metric.
*
*
* @param metricValueList
* The values for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricValueList(Collection metricValueList);
/**
*
* The values for the metric.
*
*
* @param metricValueList
* The values for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricValueList(Double... metricValueList);
}
static final class BuilderImpl implements Builder {
private String timeSeriesId;
private List dimensionList = DefaultSdkAutoConstructList.getInstance();
private List metricValueList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(TimeSeries model) {
timeSeriesId(model.timeSeriesId);
dimensionList(model.dimensionList);
metricValueList(model.metricValueList);
}
public final String getTimeSeriesId() {
return timeSeriesId;
}
public final void setTimeSeriesId(String timeSeriesId) {
this.timeSeriesId = timeSeriesId;
}
@Override
public final Builder timeSeriesId(String timeSeriesId) {
this.timeSeriesId = timeSeriesId;
return this;
}
public final List getDimensionList() {
List result = DimensionNameValueListCopier.copyToBuilder(this.dimensionList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDimensionList(Collection dimensionList) {
this.dimensionList = DimensionNameValueListCopier.copyFromBuilder(dimensionList);
}
@Override
public final Builder dimensionList(Collection dimensionList) {
this.dimensionList = DimensionNameValueListCopier.copy(dimensionList);
return this;
}
@Override
@SafeVarargs
public final Builder dimensionList(DimensionNameValue... dimensionList) {
dimensionList(Arrays.asList(dimensionList));
return this;
}
@Override
@SafeVarargs
public final Builder dimensionList(Consumer... dimensionList) {
dimensionList(Stream.of(dimensionList).map(c -> DimensionNameValue.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Collection getMetricValueList() {
if (metricValueList instanceof SdkAutoConstructList) {
return null;
}
return metricValueList;
}
public final void setMetricValueList(Collection metricValueList) {
this.metricValueList = MetricValueListCopier.copy(metricValueList);
}
@Override
public final Builder metricValueList(Collection metricValueList) {
this.metricValueList = MetricValueListCopier.copy(metricValueList);
return this;
}
@Override
@SafeVarargs
public final Builder metricValueList(Double... metricValueList) {
metricValueList(Arrays.asList(metricValueList));
return this;
}
@Override
public TimeSeries build() {
return new TimeSeries(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}