Package software.amazon.awssdk.services.pipes.model

Class PipeTargetTimestreamParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeTargetTimestreamParameters

All Implemented Interfaces:

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

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

The parameters for using a Timestream for LiveAnalytics table as a target.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipeTargetTimestreamParameters.Builder

Method Summary

Modifier and Type	Method	Description
static PipeTargetTimestreamParameters.Builder	builder()
List<DimensionMapping>	dimensionMappings()	Map source data to dimensions in the target Timestream for LiveAnalytics table.
EpochTimeUnit	epochTimeUnit()	The granularity of the time units used.
String	epochTimeUnitAsString()	The granularity of the time units used.
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	hasMultiMeasureMappings()	For responses, this returns true if the service returned a value for the MultiMeasureMappings property.
boolean	hasSingleMeasureMappings()	For responses, this returns true if the service returned a value for the SingleMeasureMappings property.
List<MultiMeasureMapping>	multiMeasureMappings()	Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeTargetTimestreamParameters.Builder>	serializableBuilderClass()
List<SingleMeasureMapping>	singleMeasureMappings()	Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
TimeFieldType	timeFieldType()	The type of time value used.
String	timeFieldTypeAsString()	The type of time value used.
String	timestampFormat()	How to format the timestamps.
String	timeValue()	Dynamic path to the source data field that represents the time value for your data.
PipeTargetTimestreamParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionValue()	64 bit version value or source data field that represents the version value for your data.

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

timeValue

public final String timeValue()

Dynamic path to the source data field that represents the time value for your data.

Returns:

Dynamic path to the source data field that represents the time value for your data.

epochTimeUnit

public final EpochTimeUnit epochTimeUnit()

The granularity of the time units used. Default is MILLISECONDS.

Required if TimeFieldType is specified as EPOCH.

If the service returns an enum value that is not available in the current SDK version, epochTimeUnit will return EpochTimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from epochTimeUnitAsString().

Returns:

The granularity of the time units used. Default is MILLISECONDS.

Required if TimeFieldType is specified as EPOCH.

See Also:

EpochTimeUnit

epochTimeUnitAsString

public final String epochTimeUnitAsString()

The granularity of the time units used. Default is MILLISECONDS.

Required if TimeFieldType is specified as EPOCH.

If the service returns an enum value that is not available in the current SDK version, epochTimeUnit will return EpochTimeUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from epochTimeUnitAsString().

Returns:

The granularity of the time units used. Default is MILLISECONDS.

Required if TimeFieldType is specified as EPOCH.

See Also:

EpochTimeUnit

timeFieldType

public final TimeFieldType timeFieldType()

The type of time value used.

The default is EPOCH.

If the service returns an enum value that is not available in the current SDK version, timeFieldType will return TimeFieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeFieldTypeAsString().

Returns:

The type of time value used.

The default is EPOCH.

See Also:

TimeFieldType

timeFieldTypeAsString

public final String timeFieldTypeAsString()

The type of time value used.

The default is EPOCH.

If the service returns an enum value that is not available in the current SDK version, timeFieldType will return TimeFieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeFieldTypeAsString().

Returns:

The type of time value used.

The default is EPOCH.

See Also:

TimeFieldType

timestampFormat

public final String timestampFormat()

How to format the timestamps. For example, YYYY-MM-DDThh:mm:ss.sssTZD.

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

Returns:

How to format the timestamps. For example, YYYY-MM-DDThh:mm:ss.sssTZD.

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

versionValue

public final String versionValue()

64 bit version value or source data field that represents the version value for your data.

Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

Default value is 1.

Timestream for LiveAnalytics does not support updating partial measure values in a record.

Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1.

Version must be 1 or greater, or you will receive a ValidationException error.

Returns:

64 bit version value or source data field that represents the version value for your data.

Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

Default value is 1.

Timestream for LiveAnalytics does not support updating partial measure values in a record.

Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1.

Version must be 1 or greater, or you will receive a ValidationException error.

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()

Map source data to dimensions in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

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:

Map source data to dimensions in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

hasSingleMeasureMappings

public final boolean hasSingleMeasureMappings()

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

singleMeasureMappings

public final List<SingleMeasureMapping> singleMeasureMappings()

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics 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 hasSingleMeasureMappings() method.

Returns:

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

hasMultiMeasureMappings

public final boolean hasMultiMeasureMappings()

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

multiMeasureMappings

public final List<MultiMeasureMapping> multiMeasureMappings()

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics 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 hasMultiMeasureMappings() method.

Returns:

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

toBuilder

public PipeTargetTimestreamParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeTargetTimestreamParameters.Builder,PipeTargetTimestreamParameters>

builder

public static PipeTargetTimestreamParameters.Builder builder()

serializableBuilderClass

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