Amazonka.IoTSiteWise.Types.AssetProperty

Documentation

data AssetProperty

Contains asset property information.

See: newAssetProperty smart constructor.

Constructors

AssetProperty'

Fields

• alias :: Maybe Text

  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.

• dataTypeSpec :: Maybe Text

  The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

• notification :: Maybe PropertyNotification

  The asset property's notification topic and state. For more information, see UpdateAssetProperty.

• unit :: Maybe Text

  The unit (such as Newtons or RPM) of the asset property.

• id :: Text

  The ID of the asset property.

• name :: Text

  The name of the property.

• dataType :: PropertyDataType

  The data type of the asset property.

Instances

FromJSON AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

parseJSON :: Value -> Parser AssetProperty

parseJSONList :: Value -> Parser [AssetProperty]

Generic AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Associated Types

type Rep AssetProperty :: Type -> Type

Methods

from :: AssetProperty -> Rep AssetProperty x

to :: Rep AssetProperty x -> AssetProperty

Read AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

readsPrec :: Int -> ReadS AssetProperty

readList :: ReadS [AssetProperty]

readPrec :: ReadPrec AssetProperty

readListPrec :: ReadPrec [AssetProperty]

Show AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

showsPrec :: Int -> AssetProperty -> ShowS

show :: AssetProperty -> String

showList :: [AssetProperty] -> ShowS

NFData AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

rnf :: AssetProperty -> ()

Eq AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

(==) :: AssetProperty -> AssetProperty -> Bool

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

Hashable AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

Methods

hashWithSalt :: Int -> AssetProperty -> Int

hash :: AssetProperty -> Int

type Rep AssetProperty

Defined in Amazonka.IoTSiteWise.Types.AssetProperty

type Rep AssetProperty = D1 ('MetaData "AssetProperty" "Amazonka.IoTSiteWise.Types.AssetProperty" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "AssetProperty'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataTypeSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropertyNotification)))) :*: ((S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PropertyDataType)))))

newAssetProperty

Arguments

:: Text

$sel:id:AssetProperty'

-> Text

$sel:name:AssetProperty'

-> PropertyDataType

$sel:dataType:AssetProperty'

-> AssetProperty

Create a value of AssetProperty 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:alias:AssetProperty', assetProperty_alias - 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.

$sel:dataTypeSpec:AssetProperty', assetProperty_dataTypeSpec - The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

$sel:notification:AssetProperty', assetProperty_notification - The asset property's notification topic and state. For more information, see UpdateAssetProperty.

$sel:unit:AssetProperty', assetProperty_unit - The unit (such as Newtons or RPM) of the asset property.

$sel:id:AssetProperty', assetProperty_id - The ID of the asset property.

$sel:name:AssetProperty', assetProperty_name - The name of the property.

$sel:dataType:AssetProperty', assetProperty_dataType - The data type of the asset property.

assetProperty_alias :: Lens' AssetProperty (Maybe Text)

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.

assetProperty_dataTypeSpec :: Lens' AssetProperty (Maybe Text)

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

assetProperty_notification :: Lens' AssetProperty (Maybe PropertyNotification)

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

assetProperty_unit :: Lens' AssetProperty (Maybe Text)

The unit (such as Newtons or RPM) of the asset property.

assetProperty_id :: Lens' AssetProperty Text

The ID of the asset property.

assetProperty_name :: Lens' AssetProperty Text

The name of the property.

assetProperty_dataType :: Lens' AssetProperty PropertyDataType

The data type of the asset property.