{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.IoTEvents.Types.AssetPropertyValue
-- 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)
module Amazonka.IoTEvents.Types.AssetPropertyValue where

import qualified Amazonka.Core as Core
import Amazonka.IoTEvents.Types.AssetPropertyTimestamp
import Amazonka.IoTEvents.Types.AssetPropertyVariant
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | A structure that contains value information. For more information, see
-- <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html AssetPropertyValue>
-- in the /AWS IoT SiteWise API Reference/.
--
-- You must use expressions for all parameters in @AssetPropertyValue@. The
-- expressions accept literals, operators, functions, references, and
-- substitution templates.
--
-- __Examples__
--
-- -   For literal values, the expressions must contain single quotes. For
--     example, the value for the @quality@ parameter can be @\'GOOD\'@.
--
-- -   For references, you must specify either variables or input values.
--     For example, the value for the @quality@ parameter can be
--     @$input.TemperatureInput.sensorData.quality@.
--
-- For more information, see
-- <https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html Expressions>
-- in the /AWS IoT Events Developer Guide/.
--
-- /See:/ 'newAssetPropertyValue' smart constructor.
data AssetPropertyValue = AssetPropertyValue'
  { -- | The value to send to an asset property.
    AssetPropertyValue -> Maybe AssetPropertyVariant
value :: Prelude.Maybe AssetPropertyVariant,
    -- | The quality of the asset property value. The value must be @\'GOOD\'@,
    -- @\'BAD\'@, or @\'UNCERTAIN\'@.
    AssetPropertyValue -> Maybe Text
quality :: Prelude.Maybe Prelude.Text,
    -- | The timestamp associated with the asset property value. The default is
    -- the current event time.
    AssetPropertyValue -> Maybe AssetPropertyTimestamp
timestamp :: Prelude.Maybe AssetPropertyTimestamp
  }
  deriving (AssetPropertyValue -> AssetPropertyValue -> Bool
(AssetPropertyValue -> AssetPropertyValue -> Bool)
-> (AssetPropertyValue -> AssetPropertyValue -> Bool)
-> Eq AssetPropertyValue
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AssetPropertyValue -> AssetPropertyValue -> Bool
$c/= :: AssetPropertyValue -> AssetPropertyValue -> Bool
== :: AssetPropertyValue -> AssetPropertyValue -> Bool
$c== :: AssetPropertyValue -> AssetPropertyValue -> Bool
Prelude.Eq, ReadPrec [AssetPropertyValue]
ReadPrec AssetPropertyValue
Int -> ReadS AssetPropertyValue
ReadS [AssetPropertyValue]
(Int -> ReadS AssetPropertyValue)
-> ReadS [AssetPropertyValue]
-> ReadPrec AssetPropertyValue
-> ReadPrec [AssetPropertyValue]
-> Read AssetPropertyValue
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AssetPropertyValue]
$creadListPrec :: ReadPrec [AssetPropertyValue]
readPrec :: ReadPrec AssetPropertyValue
$creadPrec :: ReadPrec AssetPropertyValue
readList :: ReadS [AssetPropertyValue]
$creadList :: ReadS [AssetPropertyValue]
readsPrec :: Int -> ReadS AssetPropertyValue
$creadsPrec :: Int -> ReadS AssetPropertyValue
Prelude.Read, Int -> AssetPropertyValue -> ShowS
[AssetPropertyValue] -> ShowS
AssetPropertyValue -> String
(Int -> AssetPropertyValue -> ShowS)
-> (AssetPropertyValue -> String)
-> ([AssetPropertyValue] -> ShowS)
-> Show AssetPropertyValue
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AssetPropertyValue] -> ShowS
$cshowList :: [AssetPropertyValue] -> ShowS
show :: AssetPropertyValue -> String
$cshow :: AssetPropertyValue -> String
showsPrec :: Int -> AssetPropertyValue -> ShowS
$cshowsPrec :: Int -> AssetPropertyValue -> ShowS
Prelude.Show, (forall x. AssetPropertyValue -> Rep AssetPropertyValue x)
-> (forall x. Rep AssetPropertyValue x -> AssetPropertyValue)
-> Generic AssetPropertyValue
forall x. Rep AssetPropertyValue x -> AssetPropertyValue
forall x. AssetPropertyValue -> Rep AssetPropertyValue x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AssetPropertyValue x -> AssetPropertyValue
$cfrom :: forall x. AssetPropertyValue -> Rep AssetPropertyValue x
Prelude.Generic)

-- |
-- Create a value of 'AssetPropertyValue' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'value', 'assetPropertyValue_value' - The value to send to an asset property.
--
-- 'quality', 'assetPropertyValue_quality' - The quality of the asset property value. The value must be @\'GOOD\'@,
-- @\'BAD\'@, or @\'UNCERTAIN\'@.
--
-- 'timestamp', 'assetPropertyValue_timestamp' - The timestamp associated with the asset property value. The default is
-- the current event time.
newAssetPropertyValue ::
  AssetPropertyValue
newAssetPropertyValue :: AssetPropertyValue
newAssetPropertyValue =
  AssetPropertyValue' :: Maybe AssetPropertyVariant
-> Maybe Text -> Maybe AssetPropertyTimestamp -> AssetPropertyValue
AssetPropertyValue'
    { $sel:value:AssetPropertyValue' :: Maybe AssetPropertyVariant
value = Maybe AssetPropertyVariant
forall a. Maybe a
Prelude.Nothing,
      $sel:quality:AssetPropertyValue' :: Maybe Text
quality = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:timestamp:AssetPropertyValue' :: Maybe AssetPropertyTimestamp
timestamp = Maybe AssetPropertyTimestamp
forall a. Maybe a
Prelude.Nothing
    }

-- | The value to send to an asset property.
assetPropertyValue_value :: Lens.Lens' AssetPropertyValue (Prelude.Maybe AssetPropertyVariant)
assetPropertyValue_value :: (Maybe AssetPropertyVariant -> f (Maybe AssetPropertyVariant))
-> AssetPropertyValue -> f AssetPropertyValue
assetPropertyValue_value = (AssetPropertyValue -> Maybe AssetPropertyVariant)
-> (AssetPropertyValue
    -> Maybe AssetPropertyVariant -> AssetPropertyValue)
-> Lens
     AssetPropertyValue
     AssetPropertyValue
     (Maybe AssetPropertyVariant)
     (Maybe AssetPropertyVariant)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssetPropertyValue' {Maybe AssetPropertyVariant
value :: Maybe AssetPropertyVariant
$sel:value:AssetPropertyValue' :: AssetPropertyValue -> Maybe AssetPropertyVariant
value} -> Maybe AssetPropertyVariant
value) (\s :: AssetPropertyValue
s@AssetPropertyValue' {} Maybe AssetPropertyVariant
a -> AssetPropertyValue
s {$sel:value:AssetPropertyValue' :: Maybe AssetPropertyVariant
value = Maybe AssetPropertyVariant
a} :: AssetPropertyValue)

-- | The quality of the asset property value. The value must be @\'GOOD\'@,
-- @\'BAD\'@, or @\'UNCERTAIN\'@.
assetPropertyValue_quality :: Lens.Lens' AssetPropertyValue (Prelude.Maybe Prelude.Text)
assetPropertyValue_quality :: (Maybe Text -> f (Maybe Text))
-> AssetPropertyValue -> f AssetPropertyValue
assetPropertyValue_quality = (AssetPropertyValue -> Maybe Text)
-> (AssetPropertyValue -> Maybe Text -> AssetPropertyValue)
-> Lens
     AssetPropertyValue AssetPropertyValue (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssetPropertyValue' {Maybe Text
quality :: Maybe Text
$sel:quality:AssetPropertyValue' :: AssetPropertyValue -> Maybe Text
quality} -> Maybe Text
quality) (\s :: AssetPropertyValue
s@AssetPropertyValue' {} Maybe Text
a -> AssetPropertyValue
s {$sel:quality:AssetPropertyValue' :: Maybe Text
quality = Maybe Text
a} :: AssetPropertyValue)

-- | The timestamp associated with the asset property value. The default is
-- the current event time.
assetPropertyValue_timestamp :: Lens.Lens' AssetPropertyValue (Prelude.Maybe AssetPropertyTimestamp)
assetPropertyValue_timestamp :: (Maybe AssetPropertyTimestamp -> f (Maybe AssetPropertyTimestamp))
-> AssetPropertyValue -> f AssetPropertyValue
assetPropertyValue_timestamp = (AssetPropertyValue -> Maybe AssetPropertyTimestamp)
-> (AssetPropertyValue
    -> Maybe AssetPropertyTimestamp -> AssetPropertyValue)
-> Lens
     AssetPropertyValue
     AssetPropertyValue
     (Maybe AssetPropertyTimestamp)
     (Maybe AssetPropertyTimestamp)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssetPropertyValue' {Maybe AssetPropertyTimestamp
timestamp :: Maybe AssetPropertyTimestamp
$sel:timestamp:AssetPropertyValue' :: AssetPropertyValue -> Maybe AssetPropertyTimestamp
timestamp} -> Maybe AssetPropertyTimestamp
timestamp) (\s :: AssetPropertyValue
s@AssetPropertyValue' {} Maybe AssetPropertyTimestamp
a -> AssetPropertyValue
s {$sel:timestamp:AssetPropertyValue' :: Maybe AssetPropertyTimestamp
timestamp = Maybe AssetPropertyTimestamp
a} :: AssetPropertyValue)

instance Core.FromJSON AssetPropertyValue where
  parseJSON :: Value -> Parser AssetPropertyValue
parseJSON =
    String
-> (Object -> Parser AssetPropertyValue)
-> Value
-> Parser AssetPropertyValue
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"AssetPropertyValue"
      ( \Object
x ->
          Maybe AssetPropertyVariant
-> Maybe Text -> Maybe AssetPropertyTimestamp -> AssetPropertyValue
AssetPropertyValue'
            (Maybe AssetPropertyVariant
 -> Maybe Text
 -> Maybe AssetPropertyTimestamp
 -> AssetPropertyValue)
-> Parser (Maybe AssetPropertyVariant)
-> Parser
     (Maybe Text -> Maybe AssetPropertyTimestamp -> AssetPropertyValue)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe AssetPropertyVariant)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"value")
            Parser
  (Maybe Text -> Maybe AssetPropertyTimestamp -> AssetPropertyValue)
-> Parser (Maybe Text)
-> Parser (Maybe AssetPropertyTimestamp -> AssetPropertyValue)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"quality")
            Parser (Maybe AssetPropertyTimestamp -> AssetPropertyValue)
-> Parser (Maybe AssetPropertyTimestamp)
-> Parser AssetPropertyValue
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe AssetPropertyTimestamp)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"timestamp")
      )

instance Prelude.Hashable AssetPropertyValue

instance Prelude.NFData AssetPropertyValue

instance Core.ToJSON AssetPropertyValue where
  toJSON :: AssetPropertyValue -> Value
toJSON AssetPropertyValue' {Maybe Text
Maybe AssetPropertyTimestamp
Maybe AssetPropertyVariant
timestamp :: Maybe AssetPropertyTimestamp
quality :: Maybe Text
value :: Maybe AssetPropertyVariant
$sel:timestamp:AssetPropertyValue' :: AssetPropertyValue -> Maybe AssetPropertyTimestamp
$sel:quality:AssetPropertyValue' :: AssetPropertyValue -> Maybe Text
$sel:value:AssetPropertyValue' :: AssetPropertyValue -> Maybe AssetPropertyVariant
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"value" Text -> AssetPropertyVariant -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (AssetPropertyVariant -> Pair)
-> Maybe AssetPropertyVariant -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe AssetPropertyVariant
value,
            (Text
"quality" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
quality,
            (Text
"timestamp" Text -> AssetPropertyTimestamp -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (AssetPropertyTimestamp -> Pair)
-> Maybe AssetPropertyTimestamp -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe AssetPropertyTimestamp
timestamp
          ]
      )