software.amazon.awssdk.services.timestreamquery.model

Class TimestreamConfiguration

java.lang.Object

software.amazon.awssdk.services.timestreamquery.model.TimestreamConfiguration

All Implemented Interfaces:

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

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

Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimestreamConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static TimestreamConfiguration.Builder	builder()
String	databaseName() Name of Timestream database to which the query result will be written.
List<DimensionMapping>	dimensionMappings() This is to allow mapping column(s) from the query result to the dimension in the destination table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensionMappings() For responses, this returns true if the service returned a value for the DimensionMappings property.
int	hashCode()
boolean	hasMixedMeasureMappings() For responses, this returns true if the service returned a value for the MixedMeasureMappings property.
String	measureNameColumn() Name of the measure column.
List<MixedMeasureMapping>	mixedMeasureMappings() Specifies how to map measures to multi-measure records.
MultiMeasureMappings	multiMeasureMappings() Multi-measure mappings.
List<SdkField<?>>	sdkFields()
static Class<? extends TimestreamConfiguration.Builder>	serializableBuilderClass()
String	tableName() Name of Timestream table that the query result will be written to.
String	timeColumn() Column from query result that should be used as the time column in destination table.
TimestreamConfiguration.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

databaseName

public final String databaseName()

Name of Timestream database to which the query result will be written.

Returns:

Name of Timestream database to which the query result will be written.

tableName

public final String tableName()

Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.

Returns:

Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.

timeColumn

public final String timeColumn()

Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.

Returns:

Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.

hasDimensionMappings

public final boolean hasDimensionMappings()

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

dimensionMappings

public final List<DimensionMapping> dimensionMappings()

This is to allow mapping column(s) from the query result to the dimension in the destination table.

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

Returns:

This is to allow mapping column(s) from the query result to the dimension in the destination table.

multiMeasureMappings

public final MultiMeasureMappings multiMeasureMappings()

Multi-measure mappings.

Returns:

Multi-measure mappings.

hasMixedMeasureMappings

public final boolean hasMixedMeasureMappings()

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

mixedMeasureMappings

public final List<MixedMeasureMapping> mixedMeasureMappings()

Specifies how to map measures to multi-measure records.

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

Returns:

Specifies how to map measures to multi-measure records.

measureNameColumn

public final String measureNameColumn()

Name of the measure column.

Returns:

Name of the measure column.

toBuilder

public TimestreamConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimestreamConfiguration.Builder,TimestreamConfiguration>

builder

public static TimestreamConfiguration.Builder builder()

serializableBuilderClass

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