Amazonka.IoTSiteWise.Types.Property

Documentation

data Property

Contains asset property information.

See: newProperty smart constructor.

Constructors

Property'

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.

• notification :: Maybe PropertyNotification

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

• type' :: Maybe PropertyType

  The property type (see PropertyType). A property contains one type.

• 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 property data type.

Instances

FromJSON Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

parseJSON :: Value -> Parser Property

parseJSONList :: Value -> Parser [Property]

Generic Property

Defined in Amazonka.IoTSiteWise.Types.Property

Associated Types

type Rep Property :: Type -> Type

Methods

from :: Property -> Rep Property x

to :: Rep Property x -> Property

Read Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

readsPrec :: Int -> ReadS Property

readList :: ReadS [Property]

readPrec :: ReadPrec Property

readListPrec :: ReadPrec [Property]

Show Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

NFData Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

rnf :: Property -> ()

Eq Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

(==) :: Property -> Property -> Bool

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

Hashable Property

Defined in Amazonka.IoTSiteWise.Types.Property

Methods

hashWithSalt :: Int -> Property -> Int

hash :: Property -> Int

type Rep Property

Defined in Amazonka.IoTSiteWise.Types.Property

type Rep Property = D1 ('MetaData "Property" "Amazonka.IoTSiteWise.Types.Property" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "Property'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropertyNotification)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropertyType)))) :*: ((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)))))

newProperty

Arguments

:: Text

$sel:id:Property'

-> Text

$sel:name:Property'

-> PropertyDataType

$sel:dataType:Property'

-> Property

Create a value of Property 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:Property', property_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:notification:Property', property_notification - The asset property's notification topic and state. For more information, see UpdateAssetProperty.

$sel:type':Property', property_type - The property type (see PropertyType). A property contains one type.

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

$sel:id:Property', property_id - The ID of the asset property.

$sel:name:Property', property_name - The name of the property.

$sel:dataType:Property', property_dataType - The property data type.

property_alias :: Lens' Property (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.

property_notification :: Lens' Property (Maybe PropertyNotification)

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

property_type :: Lens' Property (Maybe PropertyType)

The property type (see PropertyType). A property contains one type.

property_unit :: Lens' Property (Maybe Text)

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

property_id :: Lens' Property Text

The ID of the asset property.

property_name :: Lens' Property Text

The name of the property.

property_dataType :: Lens' Property PropertyDataType

The property data type.