software.amazon.awssdk.services.iotsitewise.model.AggregatedValue Maven / Gradle / Ivy
Show all versions of iotsitewise 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.iotsitewise.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains aggregated asset property values (for example, average, minimum, and maximum).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AggregatedValue implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("timestamp").getter(getter(AggregatedValue::timestamp)).setter(setter(Builder::timestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("timestamp").build()).build();
private static final SdkField QUALITY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("quality")
.getter(getter(AggregatedValue::qualityAsString)).setter(setter(Builder::quality))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("quality").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("value").getter(getter(AggregatedValue::value)).setter(setter(Builder::value))
.constructor(Aggregates::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TIMESTAMP_FIELD,
QUALITY_FIELD, VALUE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("timestamp", TIMESTAMP_FIELD);
put("quality", QUALITY_FIELD);
put("value", VALUE_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final Instant timestamp;
private final String quality;
private final Aggregates value;
private AggregatedValue(BuilderImpl builder) {
this.timestamp = builder.timestamp;
this.quality = builder.quality;
this.value = builder.value;
}
/**
*
* The date the aggregating computations occurred, in Unix epoch time.
*
*
* @return The date the aggregating computations occurred, in Unix epoch time.
*/
public final Instant timestamp() {
return timestamp;
}
/**
*
* The quality of the aggregated data.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #quality} will
* return {@link Quality#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #qualityAsString}.
*
*
* @return The quality of the aggregated data.
* @see Quality
*/
public final Quality quality() {
return Quality.fromValue(quality);
}
/**
*
* The quality of the aggregated data.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #quality} will
* return {@link Quality#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #qualityAsString}.
*
*
* @return The quality of the aggregated data.
* @see Quality
*/
public final String qualityAsString() {
return quality;
}
/**
*
* The value of the aggregates.
*
*
* @return The value of the aggregates.
*/
public final Aggregates value() {
return value;
}
@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(timestamp());
hashCode = 31 * hashCode + Objects.hashCode(qualityAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
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 AggregatedValue)) {
return false;
}
AggregatedValue other = (AggregatedValue) obj;
return Objects.equals(timestamp(), other.timestamp()) && Objects.equals(qualityAsString(), other.qualityAsString())
&& Objects.equals(value(), other.value());
}
/**
* 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("AggregatedValue").add("Timestamp", timestamp()).add("Quality", qualityAsString())
.add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "timestamp":
return Optional.ofNullable(clazz.cast(timestamp()));
case "quality":
return Optional.ofNullable(clazz.cast(qualityAsString()));
case "value":
return Optional.ofNullable(clazz.cast(value()));
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((AggregatedValue) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The date the aggregating computations occurred, in Unix epoch time.
*
*
* @param timestamp
* The date the aggregating computations occurred, in Unix epoch time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timestamp(Instant timestamp);
/**
*
* The quality of the aggregated data.
*
*
* @param quality
* The quality of the aggregated data.
* @see Quality
* @return Returns a reference to this object so that method calls can be chained together.
* @see Quality
*/
Builder quality(String quality);
/**
*
* The quality of the aggregated data.
*
*
* @param quality
* The quality of the aggregated data.
* @see Quality
* @return Returns a reference to this object so that method calls can be chained together.
* @see Quality
*/
Builder quality(Quality quality);
/**
*
* The value of the aggregates.
*
*
* @param value
* The value of the aggregates.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(Aggregates value);
/**
*
* The value of the aggregates.
*
* This is a convenience method that creates an instance of the {@link Aggregates.Builder} avoiding the need to
* create one manually via {@link Aggregates#builder()}.
*
*
* When the {@link Consumer} completes, {@link Aggregates.Builder#build()} is called immediately and its result
* is passed to {@link #value(Aggregates)}.
*
* @param value
* a consumer that will call methods on {@link Aggregates.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #value(Aggregates)
*/
default Builder value(Consumer value) {
return value(Aggregates.builder().applyMutation(value).build());
}
}
static final class BuilderImpl implements Builder {
private Instant timestamp;
private String quality;
private Aggregates value;
private BuilderImpl() {
}
private BuilderImpl(AggregatedValue model) {
timestamp(model.timestamp);
quality(model.quality);
value(model.value);
}
public final Instant getTimestamp() {
return timestamp;
}
public final void setTimestamp(Instant timestamp) {
this.timestamp = timestamp;
}
@Override
public final Builder timestamp(Instant timestamp) {
this.timestamp = timestamp;
return this;
}
public final String getQuality() {
return quality;
}
public final void setQuality(String quality) {
this.quality = quality;
}
@Override
public final Builder quality(String quality) {
this.quality = quality;
return this;
}
@Override
public final Builder quality(Quality quality) {
this.quality(quality == null ? null : quality.toString());
return this;
}
public final Aggregates.Builder getValue() {
return value != null ? value.toBuilder() : null;
}
public final void setValue(Aggregates.BuilderImpl value) {
this.value = value != null ? value.build() : null;
}
@Override
public final Builder value(Aggregates value) {
this.value = value;
return this;
}
@Override
public AggregatedValue build() {
return new AggregatedValue(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}