com.amazonaws.services.pipes.model

Class PipeTargetTimestreamParameters

java.lang.Object

com.amazonaws.services.pipes.model.PipeTargetTimestreamParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeTargetTimestreamParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PipeTargetTimestreamParameters()

Method Summary

Modifier and Type	Method and Description
PipeTargetTimestreamParameters	clone()
boolean	equals(Object obj)
List<DimensionMapping>	getDimensionMappings() Map source data to dimensions in the target Timestream for LiveAnalytics table.
String	getEpochTimeUnit() The granularity of the time units used.
List<MultiMeasureMapping>	getMultiMeasureMappings() Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
List<SingleMeasureMapping>	getSingleMeasureMappings() Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
String	getTimeFieldType() The type of time value used.
String	getTimestampFormat() How to format the timestamps.
String	getTimeValue() Dynamic path to the source data field that represents the time value for your data.
String	getVersionValue() 64 bit version value or source data field that represents the version value for your data.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDimensionMappings(Collection<DimensionMapping> dimensionMappings) Map source data to dimensions in the target Timestream for LiveAnalytics table.
void	setEpochTimeUnit(String epochTimeUnit) The granularity of the time units used.
void	setMultiMeasureMappings(Collection<MultiMeasureMapping> multiMeasureMappings) Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
void	setSingleMeasureMappings(Collection<SingleMeasureMapping> singleMeasureMappings) Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
void	setTimeFieldType(String timeFieldType) The type of time value used.
void	setTimestampFormat(String timestampFormat) How to format the timestamps.
void	setTimeValue(String timeValue) Dynamic path to the source data field that represents the time value for your data.
void	setVersionValue(String versionValue) 64 bit version value or source data field that represents the version value for your data.
String	toString() Returns a string representation of this object.
PipeTargetTimestreamParameters	withDimensionMappings(Collection<DimensionMapping> dimensionMappings) Map source data to dimensions in the target Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withDimensionMappings(DimensionMapping... dimensionMappings) Map source data to dimensions in the target Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withEpochTimeUnit(EpochTimeUnit epochTimeUnit) The granularity of the time units used.
PipeTargetTimestreamParameters	withEpochTimeUnit(String epochTimeUnit) The granularity of the time units used.
PipeTargetTimestreamParameters	withMultiMeasureMappings(Collection<MultiMeasureMapping> multiMeasureMappings) Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withMultiMeasureMappings(MultiMeasureMapping... multiMeasureMappings) Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withSingleMeasureMappings(Collection<SingleMeasureMapping> singleMeasureMappings) Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withSingleMeasureMappings(SingleMeasureMapping... singleMeasureMappings) Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.
PipeTargetTimestreamParameters	withTimeFieldType(String timeFieldType) The type of time value used.
PipeTargetTimestreamParameters	withTimeFieldType(TimeFieldType timeFieldType) The type of time value used.
PipeTargetTimestreamParameters	withTimestampFormat(String timestampFormat) How to format the timestamps.
PipeTargetTimestreamParameters	withTimeValue(String timeValue) Dynamic path to the source data field that represents the time value for your data.
PipeTargetTimestreamParameters	withVersionValue(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PipeTargetTimestreamParameters

public PipeTargetTimestreamParameters()

Method Detail

setTimeValue

public void setTimeValue(String timeValue)

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

Parameters:

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

getTimeValue

public String getTimeValue()

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.

withTimeValue

public PipeTargetTimestreamParameters withTimeValue(String timeValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEpochTimeUnit

public void setEpochTimeUnit(String epochTimeUnit)

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

Required if TimeFieldType is specified as EPOCH.

Parameters:

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

Required if TimeFieldType is specified as EPOCH.

See Also:

EpochTimeUnit

getEpochTimeUnit

public String getEpochTimeUnit()

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

Required if TimeFieldType is specified as EPOCH.

Returns:

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

Required if TimeFieldType is specified as EPOCH.

See Also:

EpochTimeUnit

withEpochTimeUnit

public PipeTargetTimestreamParameters withEpochTimeUnit(String epochTimeUnit)

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

Required if TimeFieldType is specified as EPOCH.

Parameters:

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

Required if TimeFieldType is specified as EPOCH.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EpochTimeUnit

withEpochTimeUnit

public PipeTargetTimestreamParameters withEpochTimeUnit(EpochTimeUnit epochTimeUnit)

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

Required if TimeFieldType is specified as EPOCH.

Parameters:

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

Required if TimeFieldType is specified as EPOCH.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EpochTimeUnit

setTimeFieldType

public void setTimeFieldType(String timeFieldType)

The type of time value used.

The default is EPOCH.

Parameters:

timeFieldType - The type of time value used.

The default is EPOCH.

See Also:

TimeFieldType

getTimeFieldType

public String getTimeFieldType()

The type of time value used.

The default is EPOCH.

Returns:

The type of time value used.

The default is EPOCH.

See Also:

TimeFieldType

withTimeFieldType

public PipeTargetTimestreamParameters withTimeFieldType(String timeFieldType)

The type of time value used.

The default is EPOCH.

Parameters:

timeFieldType - The type of time value used.

The default is EPOCH.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimeFieldType

withTimeFieldType

public PipeTargetTimestreamParameters withTimeFieldType(TimeFieldType timeFieldType)

The type of time value used.

The default is EPOCH.

Parameters:

timeFieldType - The type of time value used.

The default is EPOCH.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TimeFieldType

setTimestampFormat

public void setTimestampFormat(String timestampFormat)

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

Parameters:

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

getTimestampFormat

public String getTimestampFormat()

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.

withTimestampFormat

public PipeTargetTimestreamParameters withTimestampFormat(String timestampFormat)

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

Parameters:

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVersionValue

public void setVersionValue(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.

Parameters:

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.

getVersionValue

public String getVersionValue()

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.

withVersionValue

public PipeTargetTimestreamParameters withVersionValue(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getDimensionMappings

public List<DimensionMapping> getDimensionMappings()

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

For more information, see Amazon Timestream for LiveAnalytics concepts

Returns:

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

For more information, see Amazon Timestream for LiveAnalytics concepts

setDimensionMappings

public void setDimensionMappings(Collection<DimensionMapping> dimensionMappings)

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

For more information, see Amazon Timestream for LiveAnalytics concepts

Parameters:

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

For more information, see Amazon Timestream for LiveAnalytics concepts

withDimensionMappings

public PipeTargetTimestreamParameters withDimensionMappings(DimensionMapping... dimensionMappings)

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

For more information, see Amazon Timestream for LiveAnalytics concepts

NOTE: This method appends the values to the existing list (if any). Use setDimensionMappings(java.util.Collection) or withDimensionMappings(java.util.Collection) if you want to override the existing values.

Parameters:

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

For more information, see Amazon Timestream for LiveAnalytics concepts

Returns:

Returns a reference to this object so that method calls can be chained together.

withDimensionMappings

public PipeTargetTimestreamParameters withDimensionMappings(Collection<DimensionMapping> dimensionMappings)

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

For more information, see Amazon Timestream for LiveAnalytics concepts

Parameters:

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

For more information, see Amazon Timestream for LiveAnalytics concepts

Returns:

Returns a reference to this object so that method calls can be chained together.

getSingleMeasureMappings

public List<SingleMeasureMapping> getSingleMeasureMappings()

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

Returns:

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

setSingleMeasureMappings

public void setSingleMeasureMappings(Collection<SingleMeasureMapping> singleMeasureMappings)

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

Parameters:

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

withSingleMeasureMappings

public PipeTargetTimestreamParameters withSingleMeasureMappings(SingleMeasureMapping... singleMeasureMappings)

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

NOTE: This method appends the values to the existing list (if any). Use setSingleMeasureMappings(java.util.Collection) or withSingleMeasureMappings(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSingleMeasureMappings

public PipeTargetTimestreamParameters withSingleMeasureMappings(Collection<SingleMeasureMapping> singleMeasureMappings)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getMultiMeasureMappings

public List<MultiMeasureMapping> getMultiMeasureMappings()

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

Returns:

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

setMultiMeasureMappings

public void setMultiMeasureMappings(Collection<MultiMeasureMapping> multiMeasureMappings)

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

Parameters:

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

withMultiMeasureMappings

public PipeTargetTimestreamParameters withMultiMeasureMappings(MultiMeasureMapping... multiMeasureMappings)

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

NOTE: This method appends the values to the existing list (if any). Use setMultiMeasureMappings(java.util.Collection) or withMultiMeasureMappings(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withMultiMeasureMappings

public PipeTargetTimestreamParameters withMultiMeasureMappings(Collection<MultiMeasureMapping> multiMeasureMappings)

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

Parameters:

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

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 PipeTargetTimestreamParameters 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.