Class: Aws::IoTEvents::Types::AssetPropertyValue

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

Overview

Note:

When making an API call, you may pass AssetPropertyValue data as a hash:

{
  value: { # required
    string_value: "AssetPropertyStringValue",
    integer_value: "AssetPropertyIntegerValue",
    double_value: "AssetPropertyDoubleValue",
    boolean_value: "AssetPropertyBooleanValue",
  },
  timestamp: {
    time_in_seconds: "AssetPropertyTimeInSeconds", # required
    offset_in_nanos: "AssetPropertyOffsetInNanos",
  },
  quality: "AssetPropertyQuality",
}

A structure that contains value information. For more information, see

AssetPropertyValue][1

in the *AWS IoT SiteWise API Reference*.

You must use expressions for all parameters in ‘AssetPropertyValue`. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the ‘quality` parameter can be `’GOOD’‘.

  • For references, you must specify either variables or input values. For example, the value for the ‘quality` parameter can be `$input.TemperatureInput.sensorData.quality`.

For more information, see [Expressions] in the *AWS IoT Events Developer Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html [2]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#quality ⇒ String

The quality of the asset property value. The value must be ‘’GOOD’‘, `’BAD’‘, or `’UNCERTAIN’‘.

Returns:

  • (String) 


426
427
428
429
430
431
432
 
# File 'lib/aws-sdk-iotevents/types.rb', line 426

class AssetPropertyValue < Struct.new(
  :value,
  :timestamp,
  :quality)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Types::AssetPropertyTimestamp

The timestamp associated with the asset property value. The default is the current event time.

Returns:



426
427
428
429
430
431
432
 
# File 'lib/aws-sdk-iotevents/types.rb', line 426

class AssetPropertyValue < Struct.new(
  :value,
  :timestamp,
  :quality)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::AssetPropertyVariant

The value to send to an asset property.

Returns:



426
427
428
429
430
431
432
 
# File 'lib/aws-sdk-iotevents/types.rb', line 426

class AssetPropertyValue < Struct.new(
  :value,
  :timestamp,
  :quality)
  SENSITIVE = []
  include Aws::Structure
end