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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The alias that identifies the time series.

Returns:

  • (String)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#asset_idString

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

Returns:

  • (String)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#data_typeString

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)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#data_type_specString

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)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#property_idString

The ID of the asset property.

Returns:

  • (String)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_creation_dateTime

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

Returns:

  • (Time)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_idString

The ID of the time series.

Returns:

  • (String)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_last_update_dateTime

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

Returns:

  • (Time)


7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7010

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)
  SENSITIVE = []
  include Aws::Structure
end