Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

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

Returns:

  • (String)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_dateTime

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

Returns:

  • (Time)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_idString

The ID of the entry.

Returns:

  • (String)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_aliasString

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)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_idString

The ID of the asset property, in UUID format.

Returns:

  • (String)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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

#qualitiesArray<String>

The quality by which to filter asset data.

Returns:

  • (Array<String>)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_dateTime

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

Returns:

  • (Time)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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_orderingString

The chronological sorting order of the requested information.

Default: ASCENDING

Returns:

  • (String)

1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
# File 'gems/aws-sdk-iotsitewise/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