Amazonka.IoTSiteWise.Types.VariableValue

Documentation

data VariableValue

Identifies a property value used in an expression.

See: newVariableValue smart constructor.

Constructors

VariableValue'

Fields

• hierarchyId :: Maybe Text

  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

  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 in the IoT SiteWise User Guide.

• propertyId :: Text

  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

Instances

FromJSON VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

parseJSON :: Value -> Parser VariableValue

parseJSONList :: Value -> Parser [VariableValue]

ToJSON VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

toJSON :: VariableValue -> Value

toEncoding :: VariableValue -> Encoding

toJSONList :: [VariableValue] -> Value

toEncodingList :: [VariableValue] -> Encoding

Generic VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Associated Types

type Rep VariableValue :: Type -> Type

Methods

from :: VariableValue -> Rep VariableValue x

to :: Rep VariableValue x -> VariableValue

Read VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

readsPrec :: Int -> ReadS VariableValue

readList :: ReadS [VariableValue]

readPrec :: ReadPrec VariableValue

readListPrec :: ReadPrec [VariableValue]

Show VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

showsPrec :: Int -> VariableValue -> ShowS

show :: VariableValue -> String

showList :: [VariableValue] -> ShowS

NFData VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

rnf :: VariableValue -> ()

Eq VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

(==) :: VariableValue -> VariableValue -> Bool

(/=) :: VariableValue -> VariableValue -> Bool

Hashable VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

Methods

hashWithSalt :: Int -> VariableValue -> Int

hash :: VariableValue -> Int

type Rep VariableValue

Defined in Amazonka.IoTSiteWise.Types.VariableValue

type Rep VariableValue = D1 ('MetaData "VariableValue" "Amazonka.IoTSiteWise.Types.VariableValue" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "VariableValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hierarchyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newVariableValue

Arguments

:: Text

$sel:propertyId:VariableValue'

-> VariableValue

Create a value of VariableValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hierarchyId:VariableValue', variableValue_hierarchyId - The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

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 in the IoT SiteWise User Guide.

$sel:propertyId:VariableValue', variableValue_propertyId - The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

variableValue_hierarchyId :: Lens' VariableValue (Maybe Text)

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

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 in the IoT SiteWise User Guide.

variableValue_propertyId :: Lens' VariableValue Text

The ID of the property to use as the variable. You can use the property name if it's from the same asset model.