Class: Aws::IoTSiteWise::Types::VariableValue

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

Overview

Identifies a property value used in an expression.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#hierarchy_id ⇒ String

The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify ‘externalId:` followed by the external ID. For more information, see [Using external IDs] in the *IoT SiteWise User Guide*.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same ‘propertyId`. For example, you might have separately grouped assets that come from the same asset model. For more information, see

Asset hierarchies][2

in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html

Returns:

  • (String) 


9007
9008
9009
9010
9011
9012
9013
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9007

class VariableValue < Struct.new(
  :property_id,
  :hierarchy_id,
  :property_path)
  SENSITIVE = []
  include Aws::Structure
end

#property_id ⇒ String

The ID of the property to use as the variable. You can use the property ‘name` if it’s from the same asset model. If the property has an external ID, you can specify ‘externalId:` followed by the external ID. For more information, see [Using external IDs] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids

Returns:

  • (String) 


9007
9008
9009
9010
9011
9012
9013
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9007

class VariableValue < Struct.new(
  :property_id,
  :hierarchy_id,
  :property_path)
  SENSITIVE = []
  include Aws::Structure
end

#property_path ⇒ Array<Types::AssetModelPropertyPathSegment>

The path of the property.

Returns:



9007
9008
9009
9010
9011
9012
9013
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9007

class VariableValue < Struct.new(
  :property_id,
  :hierarchy_id,
  :property_path)
  SENSITIVE = []
  include Aws::Structure
end