software.amazon.awssdk.services.iotevents.model

Class IotSiteWiseAction

java.lang.Object

software.amazon.awssdk.services.iotevents.model.IotSiteWiseAction

All Implemented Interfaces:

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

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

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

• For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

• 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 propertyAlias parameter uses a substitution template.

  'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IotSiteWiseAction.Builder

Method Summary

Modifier and Type	Method and Description
String	assetId() The ID of the asset that has the specified property.
static IotSiteWiseAction.Builder	builder()
String	entryId() A unique identifier for this entry.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	propertyAlias() The alias of the asset property.
String	propertyId() The ID of the asset property.
AssetPropertyValue	propertyValue() The value to send to the asset property.
List<SdkField<?>>	sdkFields()
static Class<? extends IotSiteWiseAction.Builder>	serializableBuilderClass()
IotSiteWiseAction.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

entryId

public final String entryId()

A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

Returns:

A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

assetId

public final String assetId()

The ID of the asset that has the specified property.

Returns:

The ID of the asset that has the specified property.

propertyId

public final String propertyId()

The ID of the asset property.

Returns:

The ID of the asset property.

propertyAlias

public final String propertyAlias()

The alias of the asset property.

Returns:

The alias of the asset property.

propertyValue

public final AssetPropertyValue propertyValue()

The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

Returns:

The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

toBuilder

public IotSiteWiseAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IotSiteWiseAction.Builder,IotSiteWiseAction>

builder

public static IotSiteWiseAction.Builder builder()

serializableBuilderClass

public static Class<? extends IotSiteWiseAction.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