software.amazon.awssdk.services.iottwinmaker.model.PropertyValueHistory Maven / Gradle / Ivy
Show all versions of iottwinmaker 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.iottwinmaker.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;
/**
*
* The history of values for a time series property.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PropertyValueHistory implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ENTITY_PROPERTY_REFERENCE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("entityPropertyReference")
.getter(getter(PropertyValueHistory::entityPropertyReference)).setter(setter(Builder::entityPropertyReference))
.constructor(EntityPropertyReference::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("entityPropertyReference").build())
.build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("values")
.getter(getter(PropertyValueHistory::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PropertyValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
ENTITY_PROPERTY_REFERENCE_FIELD, VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final EntityPropertyReference entityPropertyReference;
private final List values;
private PropertyValueHistory(BuilderImpl builder) {
this.entityPropertyReference = builder.entityPropertyReference;
this.values = builder.values;
}
/**
*
* An object that uniquely identifies an entity property.
*
*
* @return An object that uniquely identifies an entity property.
*/
public final EntityPropertyReference entityPropertyReference() {
return entityPropertyReference;
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* A list of objects that contain information about the values in the history of a time series property.
*
*
* 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 #hasValues} method.
*
*
* @return A list of objects that contain information about the values in the history of a time series property.
*/
public final List values() {
return values;
}
@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(entityPropertyReference());
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? values() : 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 PropertyValueHistory)) {
return false;
}
PropertyValueHistory other = (PropertyValueHistory) obj;
return Objects.equals(entityPropertyReference(), other.entityPropertyReference()) && hasValues() == other.hasValues()
&& Objects.equals(values(), other.values());
}
/**
* 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("PropertyValueHistory").add("EntityPropertyReference", entityPropertyReference())
.add("Values", hasValues() ? values() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "entityPropertyReference":
return Optional.ofNullable(clazz.cast(entityPropertyReference()));
case "values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PropertyValueHistory) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An object that uniquely identifies an entity property.
*
*
* @param entityPropertyReference
* An object that uniquely identifies an entity property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder entityPropertyReference(EntityPropertyReference entityPropertyReference);
/**
*
* An object that uniquely identifies an entity property.
*
* This is a convenience method that creates an instance of the {@link EntityPropertyReference.Builder} avoiding
* the need to create one manually via {@link EntityPropertyReference#builder()}.
*
*
* When the {@link Consumer} completes, {@link EntityPropertyReference.Builder#build()} is called immediately
* and its result is passed to {@link #entityPropertyReference(EntityPropertyReference)}.
*
* @param entityPropertyReference
* a consumer that will call methods on {@link EntityPropertyReference.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #entityPropertyReference(EntityPropertyReference)
*/
default Builder entityPropertyReference(Consumer entityPropertyReference) {
return entityPropertyReference(EntityPropertyReference.builder().applyMutation(entityPropertyReference).build());
}
/**
*
* A list of objects that contain information about the values in the history of a time series property.
*
*
* @param values
* A list of objects that contain information about the values in the history of a time series property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* A list of objects that contain information about the values in the history of a time series property.
*
*
* @param values
* A list of objects that contain information about the values in the history of a time series property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(PropertyValue... values);
/**
*
* A list of objects that contain information about the values in the history of a time series property.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iottwinmaker.model.PropertyValue.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.iottwinmaker.model.PropertyValue#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iottwinmaker.model.PropertyValue.Builder#build()} is called
* immediately and its result is passed to {@link #values(List)}.
*
* @param values
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.iottwinmaker.model.PropertyValue.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #values(java.util.Collection)
*/
Builder values(Consumer... values);
}
static final class BuilderImpl implements Builder {
private EntityPropertyReference entityPropertyReference;
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PropertyValueHistory model) {
entityPropertyReference(model.entityPropertyReference);
values(model.values);
}
public final EntityPropertyReference.Builder getEntityPropertyReference() {
return entityPropertyReference != null ? entityPropertyReference.toBuilder() : null;
}
public final void setEntityPropertyReference(EntityPropertyReference.BuilderImpl entityPropertyReference) {
this.entityPropertyReference = entityPropertyReference != null ? entityPropertyReference.build() : null;
}
@Override
public final Builder entityPropertyReference(EntityPropertyReference entityPropertyReference) {
this.entityPropertyReference = entityPropertyReference;
return this;
}
public final List getValues() {
List result = ValuesCopier.copyToBuilder(this.values);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setValues(Collection values) {
this.values = ValuesCopier.copyFromBuilder(values);
}
@Override
public final Builder values(Collection values) {
this.values = ValuesCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(PropertyValue... values) {
values(Arrays.asList(values));
return this;
}
@Override
@SafeVarargs
public final Builder values(Consumer... values) {
values(Stream.of(values).map(c -> PropertyValue.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public PropertyValueHistory build() {
return new PropertyValueHistory(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}