Class: Aws::IoTSiteWise::Types::TimeSeriesSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::TimeSeriesSummary

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of a time series (data stream).

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  The alias that identifies the time series.

• #asset_id ⇒ String

  The ID of the asset in which the asset property was created.

• #data_type ⇒ String

  The data type of the time series.

• #data_type_spec ⇒ String

  The data type of the structure for this time series.

• #property_id ⇒ String

  The ID of the asset property, in UUID format.

• #time_series_arn ⇒ String

  The [ARN][1] of the time series, which has the following format.

• #time_series_creation_date ⇒ Time

  The date that the time series was created, in Unix epoch time.

• #time_series_id ⇒ String

  The ID of the time series.

• #time_series_last_update_date ⇒ Time

  The date that the time series was last updated, in Unix epoch time.

Instance Attribute Details

#alias ⇒ String

The alias that identifies the time series.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#asset_id ⇒ String

The ID of the asset in which the asset property was created.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ String

The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_type_spec ⇒ String

The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#property_id ⇒ String

The ID of the asset property, in UUID format.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_arn ⇒ String

The ARN of the time series, which has the following format.

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_creation_date ⇒ Time

The date that the time series was created, in Unix epoch time.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_id ⇒ String

The ID of the time series.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_last_update_date ⇒ Time

The date that the time series was last updated, in Unix epoch time.

Returns:

• (Time)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7857

class TimeSeriesSummary < Struct.new(
  :asset_id,
  :property_id,
  :alias,
  :time_series_id,
  :data_type,
  :data_type_spec,
  :time_series_creation_date,
  :time_series_last_update_date,
  :time_series_arn)
  SENSITIVE = []
  include Aws::Structure
end