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 specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For parameters that are string data type, you can specify the following options:
- Use a string. For example, the propertyAlias value can be '/company/windfarm/3/turbine/7/temperature'.
- Use an expression. For example, the propertyAlias value can be 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature' .
  
  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. You can also specify an expression.
    
    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. You can also specify an expression.
  - 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. You can also specify an expression.
    
    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. You can also specify an expression.
  - 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. You can also specify an expression.
    
    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. You can also specify an expression.
    
    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. You can specify an expression.
    
    Parameters:
    
    assetId - The ID of the asset that has the specified property. You can specify an expression.
  - getAssetId
```
public String getAssetId()
```
    The ID of the asset that has the specified property. You can specify an expression.
    
    Returns:
    
    The ID of the asset that has the specified property. You can specify an expression.
  - withAssetId
```
public IotSiteWiseAction withAssetId(String assetId)
```
    The ID of the asset that has the specified property. You can specify an expression.
    
    Parameters:
    
    assetId - The ID of the asset that has the specified property. You can specify an expression.
    
    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. You can specify an expression.
    
    Parameters:
    
    propertyId - The ID of the asset property. You can specify an expression.
  - getPropertyId
```
public String getPropertyId()
```
    The ID of the asset property. You can specify an expression.
    
    Returns:
    
    The ID of the asset property. You can specify an expression.
  - withPropertyId
```
public IotSiteWiseAction withPropertyId(String propertyId)
```
    The ID of the asset property. You can specify an expression.
    
    Parameters:
    
    propertyId - The ID of the asset property. You can specify an expression.
    
    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. You can also specify an expression.
    
    Parameters:
    
    propertyAlias - The alias of the asset property. You can also specify an expression.
  - getPropertyAlias
```
public String getPropertyAlias()
```
    The alias of the asset property. You can also specify an expression.
    
    Returns:
    
    The alias of the asset property. You can also specify an expression.
  - withPropertyAlias
```
public IotSiteWiseAction withPropertyAlias(String propertyAlias)
```
    The alias of the asset property. You can also specify an expression.
    
    Parameters:
    
    propertyAlias - The alias of the asset property. You can also specify an expression.
    
    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.

Did this page help you?

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