IotSiteWiseAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotevents.model.IotSiteWiseAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IotSiteWiseAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IotSiteWiseAction()

Constructors
Constructor and Description
`IotSiteWiseAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IotSiteWiseAction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAssetId()` The ID of the asset that has the specified property.
`String`	`getEntryId()` A unique identifier for this entry.
`String`	`getPropertyAlias()` The alias of the asset property.
`String`	`getPropertyId()` The ID of the asset property.
`AssetPropertyValue`	`getPropertyValue()` The value to send to the asset property.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAssetId(String assetId)` The ID of the asset that has the specified property.
`void`	`setEntryId(String entryId)` A unique identifier for this entry.
`void`	`setPropertyAlias(String propertyAlias)` The alias of the asset property.
`void`	`setPropertyId(String propertyId)` The ID of the asset property.
`void`	`setPropertyValue(AssetPropertyValue propertyValue)` The value to send to the asset property.
`String`	`toString()` Returns a string representation of this object.
`IotSiteWiseAction`	`withAssetId(String assetId)` The ID of the asset that has the specified property.
`IotSiteWiseAction`	`withEntryId(String entryId)` A unique identifier for this entry.
`IotSiteWiseAction`	`withPropertyAlias(String propertyAlias)` The alias of the asset property.
`IotSiteWiseAction`	`withPropertyId(String propertyId)` The ID of the asset property.
`IotSiteWiseAction`	`withPropertyValue(AssetPropertyValue propertyValue)` The value to send to the asset property.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IotSiteWiseAction
```
public IotSiteWiseAction()
```
- Method Detail
  - setEntryId
```
public void setEntryId(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.
    
    Parameters:
    
    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.
  - getEntryId
```
public String getEntryId()
```
    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.
  - withEntryId
```
public IotSiteWiseAction withEntryId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssetId
```
public void setAssetId(String assetId)
```
    The ID of the asset that has the specified property.
    
    Parameters:
    
    assetId - The ID of the asset that has the specified property.
  - getAssetId
```
public String getAssetId()
```
    The ID of the asset that has the specified property.
    
    Returns:
    
    The ID of the asset that has the specified property.
  - withAssetId
```
public IotSiteWiseAction withAssetId(String assetId)
```
    The ID of the asset that has the specified property.
    
    Parameters:
    
    assetId - The ID of the asset that has the specified property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyId
```
public void setPropertyId(String propertyId)
```
    The ID of the asset property.
    
    Parameters:
    
    propertyId - The ID of the asset property.
  - getPropertyId
```
public String getPropertyId()
```
    The ID of the asset property.
    
    Returns:
    
    The ID of the asset property.
  - withPropertyId
```
public IotSiteWiseAction withPropertyId(String propertyId)
```
    The ID of the asset property.
    
    Parameters:
    
    propertyId - The ID of the asset property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyAlias
```
public void setPropertyAlias(String propertyAlias)
```
    The alias of the asset property.
    
    Parameters:
    
    propertyAlias - The alias of the asset property.
  - getPropertyAlias
```
public String getPropertyAlias()
```
    The alias of the asset property.
    
    Returns:
    
    The alias of the asset property.
  - withPropertyAlias
```
public IotSiteWiseAction withPropertyAlias(String propertyAlias)
```
    The alias of the asset property.
    
    Parameters:
    
    propertyAlias - The alias of the asset property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyValue
```
public void setPropertyValue(AssetPropertyValue propertyValue)
```
    The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
    
    Parameters:
    
    propertyValue - The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
  - getPropertyValue
```
public AssetPropertyValue getPropertyValue()
```
    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.
  - withPropertyValue
```
public IotSiteWiseAction withPropertyValue(AssetPropertyValue propertyValue)
```
    The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
    
    Parameters:
    
    propertyValue - The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IotSiteWiseAction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class IotSiteWiseAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IotSiteWiseAction

Method Detail

setEntryId

getEntryId

withEntryId

setAssetId

getAssetId

withAssetId

setPropertyId

getPropertyId

withPropertyId

setPropertyAlias

getPropertyAlias

withPropertyAlias

setPropertyValue

getPropertyValue

withPropertyValue

toString

equals

hashCode

clone

marshall