Class: Aws::IoTSiteWise::Types::BatchGetAssetPropertyValueHistoryEntry

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

Overview

Contains information for an asset property historical value entry that is associated with the [BatchGetAssetPropertyValueHistory] 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_BatchGetAssetPropertyValue.html [2]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ String

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



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :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.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :start_date,
  :end_date,
  :qualities,
  :time_ordering)
  SENSITIVE = []
  include Aws::Structure
end

#entry_id ⇒ String

The ID of the entry.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :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



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :start_date,
  :end_date,
  :qualities,
  :time_ordering)
  SENSITIVE = []
  include Aws::Structure
end

#property_id ⇒ String

The ID of the asset property, in UUID format.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :start_date,
  :end_date,
  :qualities,
  :time_ordering)
  SENSITIVE = []
  include Aws::Structure
end

#qualities ⇒ Array<String>

The quality by which to filter asset data.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :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.



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :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`



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 1980

class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :start_date,
  :end_date,
  :qualities,
  :time_ordering)
  SENSITIVE = []
  include Aws::Structure
end