Struct aws_sdk_pipes::types::PipeTargetTimestreamParameters

#[non_exhaustive]
pub struct PipeTargetTimestreamParameters {
    pub time_value: String,
    pub epoch_time_unit: Option<EpochTimeUnit>,
    pub time_field_type: Option<TimeFieldType>,
    pub timestamp_format: Option<String>,
    pub version_value: String,
    pub dimension_mappings: Vec<DimensionMapping>,
    pub single_measure_mappings: Option<Vec<SingleMeasureMapping>>,
    pub multi_measure_mappings: Option<Vec<MultiMeasureMapping>>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time_value: String

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

epoch_time_unit: Option<EpochTimeUnit>

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

Required if TimeFieldType is specified as EPOCH.

time_field_type: Option<TimeFieldType>

The type of time value used.

The default is EPOCH.

timestamp_format: Option<String>

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

version_value: String

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.

dimension_mappings: Vec<DimensionMapping>

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

For more information, see Amazon Timestream for LiveAnalytics concepts

single_measure_mappings: Option<Vec<SingleMeasureMapping>>

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

multi_measure_mappings: Option<Vec<MultiMeasureMapping>>

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

Implementations

impl PipeTargetTimestreamParameters

pub fn time_value(&self) -> &str

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

pub fn epoch_time_unit(&self) -> Option<&EpochTimeUnit>

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

Required if TimeFieldType is specified as EPOCH.

pub fn time_field_type(&self) -> Option<&TimeFieldType>

The type of time value used.

The default is EPOCH.

pub fn timestamp_format(&self) -> Option<&str>

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

Required if TimeFieldType is specified as TIMESTAMP_FORMAT.

pub fn version_value(&self) -> &str

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.

pub fn dimension_mappings(&self) -> &[DimensionMapping]

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

For more information, see Amazon Timestream for LiveAnalytics concepts

pub fn single_measure_mappings(&self) -> &[SingleMeasureMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .single_measure_mappings.is_none().

pub fn multi_measure_mappings(&self) -> &[MultiMeasureMapping]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .multi_measure_mappings.is_none().

impl PipeTargetTimestreamParameters

pub fn builder() -> PipeTargetTimestreamParametersBuilder

Creates a new builder-style object to manufacture PipeTargetTimestreamParameters.

Trait Implementations

impl Clone for PipeTargetTimestreamParameters

fn clone(&self) -> PipeTargetTimestreamParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipeTargetTimestreamParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PipeTargetTimestreamParameters

fn eq(&self, other: &PipeTargetTimestreamParameters) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipeTargetTimestreamParameters