Class: Aws::IoTSiteWise::Types::BatchGetAssetPropertyAggregatesEntry

Inherits:
Struct
  • Object
show all
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 and propertyId 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

Instance Attribute Details

#aggregate_types ⇒ Array<String>

The data aggregating function.

Returns:

  • (Array<String>) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (Time) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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, in UUID format.

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (Array<String>) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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.

Returns:

  • (Time) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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

Returns:

  • (String) 


1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1778

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