software.amazon.awssdk.services.iot.model

Class IotAnalyticsAction

java.lang.Object

software.amazon.awssdk.services.iot.model.IotAnalyticsAction

All Implemented Interfaces:

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

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

Sends message data to an AWS IoT Analytics channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IotAnalyticsAction.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	batchMode() Whether to process the action as a batch.
static IotAnalyticsAction.Builder	builder()
String	channelArn() (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
String	channelName() The name of the IoT Analytics channel to which message data will be sent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn() The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
List<SdkField<?>>	sdkFields()
static Class<? extends IotAnalyticsAction.Builder>	serializableBuilderClass()
IotAnalyticsAction.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

channelArn

public final String channelArn()

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Returns:

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

channelName

public final String channelName()

The name of the IoT Analytics channel to which message data will be sent.

Returns:

The name of the IoT Analytics channel to which message data will be sent.

batchMode

public final Boolean batchMode()

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

Returns:

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

roleArn

public final String roleArn()

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Returns:

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

toBuilder

public IotAnalyticsAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IotAnalyticsAction.Builder,IotAnalyticsAction>

builder

public static IotAnalyticsAction.Builder builder()

serializableBuilderClass

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