Package software.amazon.awssdk.services.iot.model

Class TimestreamAction

java.lang.Object

software.amazon.awssdk.services.iot.model.TimestreamAction

All Implemented Interfaces:

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

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

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimestreamAction.Builder

Method Summary

Modifier and Type	Method	Description
static TimestreamAction.Builder	builder()
String	databaseName()	The name of an Amazon Timestream database.
List<TimestreamDimension>	dimensions()	Metadata attributes of the time series that are written in each measure record.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions()	For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
String	roleArn()	The ARN of the role that grants permission to write to the Amazon Timestream database table.
List<SdkField<?>>	sdkFields()
static Class<? extends TimestreamAction.Builder>	serializableBuilderClass()
String	tableName()	The name of the database table into which to write the measure records.
TimestreamTimestamp	timestamp()	Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.
TimestreamAction.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

roleArn

public final String roleArn()

The ARN of the role that grants permission to write to the Amazon Timestream database table.

Returns:

The ARN of the role that grants permission to write to the Amazon Timestream database table.

databaseName

public final String databaseName()

The name of an Amazon Timestream database.

Returns:

The name of an Amazon Timestream database.

tableName

public final String tableName()

The name of the database table into which to write the measure records.

Returns:

The name of the database table into which to write the measure records.

hasDimensions

public final boolean hasDimensions()

For responses, this returns true if the service returned a value for the Dimensions 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.

dimensions

public final List<TimestreamDimension> dimensions()

Metadata attributes of the time series that are written in each measure record.

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

Returns:

Metadata attributes of the time series that are written in each measure record.

timestamp

public final TimestreamTimestamp timestamp()

Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

Returns:

Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

toBuilder

public TimestreamAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimestreamAction.Builder,TimestreamAction>

builder

public static TimestreamAction.Builder builder()

serializableBuilderClass

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