software.amazon.awssdk.services.iotevents.model.AssetPropertyVariant Maven / Gradle / Ivy
Show all versions of iotevents 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.iotevents.model;
import java.io.Serializable;
import java.util.Arrays;
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.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;
/**
*
* A structure that contains an asset property value. For more information, see Variant in the AWS IoT
* SiteWise API Reference.
*
*
* You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals,
* operators, functions, references, and substitution templates.
*
*
* Examples
*
*
* -
*
* For literal values, the expressions must contain single quotes. For example, the value for the
* integerValue parameter can be '100'.
*
*
* -
*
* For references, you must specify either variables or parameters. For example, the value for the
* booleanValue parameter can be $variable.offline.
*
*
* -
*
* For a substitution template, you must use ${}, and the template must be in single quotes. A substitution
* template can also contain a combination of literals, operators, functions, references, and substitution templates.
*
*
* In the following example, the value for the doubleValue parameter uses a substitution template.
*
*
* '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'
*
*
*
*
* For more information, see Expressions in the
* AWS IoT Events Developer Guide.
*
*
* You must specify one of the following value types, depending on the dataType of the specified asset
* property. For more information, see AssetProperty in the
* AWS IoT SiteWise API Reference.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AssetPropertyVariant implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STRING_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("stringValue").getter(getter(AssetPropertyVariant::stringValue)).setter(setter(Builder::stringValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("stringValue").build()).build();
private static final SdkField INTEGER_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("integerValue").getter(getter(AssetPropertyVariant::integerValue)).setter(setter(Builder::integerValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("integerValue").build()).build();
private static final SdkField DOUBLE_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("doubleValue").getter(getter(AssetPropertyVariant::doubleValue)).setter(setter(Builder::doubleValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("doubleValue").build()).build();
private static final SdkField BOOLEAN_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("booleanValue").getter(getter(AssetPropertyVariant::booleanValue)).setter(setter(Builder::booleanValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("booleanValue").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STRING_VALUE_FIELD,
INTEGER_VALUE_FIELD, DOUBLE_VALUE_FIELD, BOOLEAN_VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String stringValue;
private final String integerValue;
private final String doubleValue;
private final String booleanValue;
private AssetPropertyVariant(BuilderImpl builder) {
this.stringValue = builder.stringValue;
this.integerValue = builder.integerValue;
this.doubleValue = builder.doubleValue;
this.booleanValue = builder.booleanValue;
}
/**
*
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
*
*
* @return The asset property value is a string. You must use an expression, and the evaluated result should be a
* string.
*/
public final String stringValue() {
return stringValue;
}
/**
*
* The asset property value is an integer. You must use an expression, and the evaluated result should be an
* integer.
*
*
* @return The asset property value is an integer. You must use an expression, and the evaluated result should be an
* integer.
*/
public final String integerValue() {
return integerValue;
}
/**
*
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
*
*
* @return The asset property value is a double. You must use an expression, and the evaluated result should be a
* double.
*/
public final String doubleValue() {
return doubleValue;
}
/**
*
* The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must
* use an expression, and the evaluated result should be a Boolean value.
*
*
* @return The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You
* must use an expression, and the evaluated result should be a Boolean value.
*/
public final String booleanValue() {
return booleanValue;
}
@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(stringValue());
hashCode = 31 * hashCode + Objects.hashCode(integerValue());
hashCode = 31 * hashCode + Objects.hashCode(doubleValue());
hashCode = 31 * hashCode + Objects.hashCode(booleanValue());
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 AssetPropertyVariant)) {
return false;
}
AssetPropertyVariant other = (AssetPropertyVariant) obj;
return Objects.equals(stringValue(), other.stringValue()) && Objects.equals(integerValue(), other.integerValue())
&& Objects.equals(doubleValue(), other.doubleValue()) && Objects.equals(booleanValue(), other.booleanValue());
}
/**
* 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("AssetPropertyVariant").add("StringValue", stringValue()).add("IntegerValue", integerValue())
.add("DoubleValue", doubleValue()).add("BooleanValue", booleanValue()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "stringValue":
return Optional.ofNullable(clazz.cast(stringValue()));
case "integerValue":
return Optional.ofNullable(clazz.cast(integerValue()));
case "doubleValue":
return Optional.ofNullable(clazz.cast(doubleValue()));
case "booleanValue":
return Optional.ofNullable(clazz.cast(booleanValue()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AssetPropertyVariant) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The asset property value is a string. You must use an expression, and the evaluated result should be a
* string.
*
*
* @param stringValue
* The asset property value is a string. You must use an expression, and the evaluated result should be a
* string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stringValue(String stringValue);
/**
*
* The asset property value is an integer. You must use an expression, and the evaluated result should be an
* integer.
*
*
* @param integerValue
* The asset property value is an integer. You must use an expression, and the evaluated result should be
* an integer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder integerValue(String integerValue);
/**
*
* The asset property value is a double. You must use an expression, and the evaluated result should be a
* double.
*
*
* @param doubleValue
* The asset property value is a double. You must use an expression, and the evaluated result should be a
* double.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder doubleValue(String doubleValue);
/**
*
* The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You
* must use an expression, and the evaluated result should be a Boolean value.
*
*
* @param booleanValue
* The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'.
* You must use an expression, and the evaluated result should be a Boolean value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder booleanValue(String booleanValue);
}
static final class BuilderImpl implements Builder {
private String stringValue;
private String integerValue;
private String doubleValue;
private String booleanValue;
private BuilderImpl() {
}
private BuilderImpl(AssetPropertyVariant model) {
stringValue(model.stringValue);
integerValue(model.integerValue);
doubleValue(model.doubleValue);
booleanValue(model.booleanValue);
}
public final String getStringValue() {
return stringValue;
}
public final void setStringValue(String stringValue) {
this.stringValue = stringValue;
}
@Override
public final Builder stringValue(String stringValue) {
this.stringValue = stringValue;
return this;
}
public final String getIntegerValue() {
return integerValue;
}
public final void setIntegerValue(String integerValue) {
this.integerValue = integerValue;
}
@Override
public final Builder integerValue(String integerValue) {
this.integerValue = integerValue;
return this;
}
public final String getDoubleValue() {
return doubleValue;
}
public final void setDoubleValue(String doubleValue) {
this.doubleValue = doubleValue;
}
@Override
public final Builder doubleValue(String doubleValue) {
this.doubleValue = doubleValue;
return this;
}
public final String getBooleanValue() {
return booleanValue;
}
public final void setBooleanValue(String booleanValue) {
this.booleanValue = booleanValue;
}
@Override
public final Builder booleanValue(String booleanValue) {
this.booleanValue = booleanValue;
return this;
}
@Override
public AssetPropertyVariant build() {
return new AssetPropertyVariant(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}