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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::BatchGetAssetPropertyAggregatesEntry

Includes:

Structure

Defined in:

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].

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html [2]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #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.

Returns:

• (Array<String>)

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

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)

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

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)

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

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)

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

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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html

Returns:

• (String)

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

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)

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

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>)

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

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)

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

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)

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

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)

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

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