Class: Aws::IoTSiteWise::Types::BatchGetAssetPropertyAggregatesEntry
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::BatchGetAssetPropertyAggregatesEntry
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Overview
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
The
assetId
andpropertyId
of an asset property.A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#aggregate_types ⇒ Array<String>
The data aggregating function.
-
#asset_id ⇒ String
The ID of the asset in which the asset property was created.
-
#end_date ⇒ Time
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
-
#entry_id ⇒ String
The ID of the entry.
-
#property_alias ⇒ String
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). -
#property_id ⇒ String
The ID of the asset property.
-
#qualities ⇒ Array<String>
The quality by which to filter asset data.
-
#resolution ⇒ String
The time interval over which to aggregate data.
-
#start_date ⇒ Time
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
-
#time_ordering ⇒ String
The chronological sorting order of the requested information.
Instance Attribute Details
#aggregate_types ⇒ Array<String>
The data aggregating function.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#asset_id ⇒ String
The ID of the asset in which the asset property was created.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#end_date ⇒ Time
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#entry_id ⇒ String
The ID of the entry.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#property_alias ⇒ String
The alias that identifies the property, such as an OPC-UA server
data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information,
see Mapping industrial data streams to asset properties in the
IoT SiteWise User Guide.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#property_id ⇒ String
The ID of the asset property.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#qualities ⇒ Array<String>
The quality by which to filter asset data.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#resolution ⇒ String
The time interval over which to aggregate data.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#start_date ⇒ Time
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |
#time_ordering ⇒ String
The chronological sorting order of the requested information.
Default: ASCENDING
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1093 class BatchGetAssetPropertyAggregatesEntry < Struct.new( :entry_id, :asset_id, :property_id, :property_alias, :aggregate_types, :resolution, :start_date, :end_date, :qualities, :time_ordering) SENSITIVE = [] include Aws::Structure end |