Package software.amazon.awssdk.services.iotsitewise.model

Class Transform

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.Transform

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Transform.Builder,Transform>

@Generated("software.amazon.awssdk:codegen")
public final class Transform
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Transform.Builder,Transform>

Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Transforms in the IoT SiteWise User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Transform.Builder

Method Summary

Modifier and Type	Method	Description
static Transform.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expression()	The mathematical expression that defines the transformation function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariables()	For responses, this returns true if the service returned a value for the Variables property.
TransformProcessingConfig	processingConfig()	The processing configuration for the given transform property.
List<SdkField<?>>	sdkFields()
static Class<? extends Transform.Builder>	serializableBuilderClass()
Transform.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<ExpressionVariable>	variables()	The list of variables used in the expression.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

expression

public final String expression()

The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

Returns:

The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

hasVariables

public final boolean hasVariables()

For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

variables

public final List<ExpressionVariable> variables()

The list of variables used in the expression.

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 hasVariables() method.

Returns:

The list of variables used in the expression.

processingConfig

public final TransformProcessingConfig processingConfig()

The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

Returns:

The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

toBuilder

public Transform.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Transform.Builder,Transform>

builder

public static Transform.Builder builder()

serializableBuilderClass

public static Class<? extends Transform.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo