Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.Types.Property

Description

Synopsis

data Property = Property' {
- notification :: Maybe PropertyNotification
- alias :: Maybe Text
- type' :: Maybe PropertyType
- unit :: Maybe Text
- id :: Text
- name :: Text
- dataType :: PropertyDataType
}
newProperty :: Text -> Text -> PropertyDataType -> Property
property_notification :: Lens' Property (Maybe PropertyNotification)
property_alias :: Lens' Property (Maybe Text)
property_type :: Lens' Property (Maybe PropertyType)
property_unit :: Lens' Property (Maybe Text)
property_id :: Lens' Property Text
property_name :: Lens' Property Text
property_dataType :: Lens' Property PropertyDataType

Documentation

data Property Source #

Contains asset property information.

See: newProperty smart constructor.

Constructors

Property'

Fields

notification :: Maybe PropertyNotification
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
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.
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

Instances details

Eq Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods (==) :: Property -> Property -> Bool # (/=) :: Property -> Property -> Bool #
Read Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods readsPrec :: Int -> ReadS Property # readList :: ReadS [Property] # readPrec :: ReadPrec Property # readListPrec :: ReadPrec [Property] #
Show Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods showsPrec :: Int -> Property -> ShowS # show :: Property -> String # showList :: [Property] -> ShowS #
Generic Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Associated Types type Rep Property :: Type -> Type # Methods from :: Property -> Rep Property x # to :: Rep Property x -> Property #
NFData Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods rnf :: Property -> () #
Hashable Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods hashWithSalt :: Int -> Property -> Int # hash :: Property -> Int #
FromJSON Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property Methods parseJSON :: Value -> Parser Property # parseJSONList :: Value -> Parser [Property] #
type Rep Property Source #
Instance details Defined in Amazonka.IoTSiteWise.Types.Property type Rep Property = D1 ('MetaData "Property" "Amazonka.IoTSiteWise.Types.Property" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "Property'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropertyNotification)) :: (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 Source #

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

$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: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_notification :: Lens' Property (Maybe PropertyNotification) Source #

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

property_alias :: Lens' Property (Maybe Text) Source #

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_type :: Lens' Property (Maybe PropertyType) Source #

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

property_unit :: Lens' Property (Maybe Text) Source #

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

property_id :: Lens' Property Text Source #

The ID of the asset property.

property_name :: Lens' Property Text Source #

The name of the property.

property_dataType :: Lens' Property PropertyDataType Source #

The property data type.