{-# 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.CloudWatch.Types.MetricDataResult
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.CloudWatch.Types.MetricDataResult where

import Amazonka.CloudWatch.Types.MessageData
import Amazonka.CloudWatch.Types.StatusCode
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | A @GetMetricData@ call returns an array of @MetricDataResult@
-- structures. Each of these structures includes the data points for that
-- metric, along with the timestamps of those data points and other
-- identifying information.
--
-- /See:/ 'newMetricDataResult' smart constructor.
data MetricDataResult = MetricDataResult'
  { -- | The short name you specified to represent this metric.
    MetricDataResult -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | The human-readable label associated with the data.
    MetricDataResult -> Maybe Text
label :: Prelude.Maybe Prelude.Text,
    -- | A list of messages with additional information about the data returned.
    MetricDataResult -> Maybe [MessageData]
messages :: Prelude.Maybe [MessageData],
    -- | The status of the returned data. @Complete@ indicates that all data
    -- points in the requested time range were returned. @PartialData@ means
    -- that an incomplete set of data points were returned. You can use the
    -- @NextToken@ value that was returned and repeat your request to get more
    -- data points. @NextToken@ is not returned if you are performing a math
    -- expression. @InternalError@ indicates that an error occurred. Retry your
    -- request using @NextToken@, if present.
    MetricDataResult -> Maybe StatusCode
statusCode :: Prelude.Maybe StatusCode,
    -- | The timestamps for the data points, formatted in Unix timestamp format.
    -- The number of timestamps always matches the number of values and the
    -- value for Timestamps[x] is Values[x].
    MetricDataResult -> Maybe [ISO8601]
timestamps :: Prelude.Maybe [Data.ISO8601],
    -- | The data points for the metric corresponding to @Timestamps@. The number
    -- of values always matches the number of timestamps and the timestamp for
    -- Values[x] is Timestamps[x].
    MetricDataResult -> Maybe [Double]
values :: Prelude.Maybe [Prelude.Double]
  }
  deriving (MetricDataResult -> MetricDataResult -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricDataResult -> MetricDataResult -> Bool
$c/= :: MetricDataResult -> MetricDataResult -> Bool
== :: MetricDataResult -> MetricDataResult -> Bool
$c== :: MetricDataResult -> MetricDataResult -> Bool
Prelude.Eq, ReadPrec [MetricDataResult]
ReadPrec MetricDataResult
Int -> ReadS MetricDataResult
ReadS [MetricDataResult]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricDataResult]
$creadListPrec :: ReadPrec [MetricDataResult]
readPrec :: ReadPrec MetricDataResult
$creadPrec :: ReadPrec MetricDataResult
readList :: ReadS [MetricDataResult]
$creadList :: ReadS [MetricDataResult]
readsPrec :: Int -> ReadS MetricDataResult
$creadsPrec :: Int -> ReadS MetricDataResult
Prelude.Read, Int -> MetricDataResult -> ShowS
[MetricDataResult] -> ShowS
MetricDataResult -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricDataResult] -> ShowS
$cshowList :: [MetricDataResult] -> ShowS
show :: MetricDataResult -> String
$cshow :: MetricDataResult -> String
showsPrec :: Int -> MetricDataResult -> ShowS
$cshowsPrec :: Int -> MetricDataResult -> ShowS
Prelude.Show, forall x. Rep MetricDataResult x -> MetricDataResult
forall x. MetricDataResult -> Rep MetricDataResult x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricDataResult x -> MetricDataResult
$cfrom :: forall x. MetricDataResult -> Rep MetricDataResult x
Prelude.Generic)

-- |
-- Create a value of 'MetricDataResult' 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:
--
-- 'id', 'metricDataResult_id' - The short name you specified to represent this metric.
--
-- 'label', 'metricDataResult_label' - The human-readable label associated with the data.
--
-- 'messages', 'metricDataResult_messages' - A list of messages with additional information about the data returned.
--
-- 'statusCode', 'metricDataResult_statusCode' - The status of the returned data. @Complete@ indicates that all data
-- points in the requested time range were returned. @PartialData@ means
-- that an incomplete set of data points were returned. You can use the
-- @NextToken@ value that was returned and repeat your request to get more
-- data points. @NextToken@ is not returned if you are performing a math
-- expression. @InternalError@ indicates that an error occurred. Retry your
-- request using @NextToken@, if present.
--
-- 'timestamps', 'metricDataResult_timestamps' - The timestamps for the data points, formatted in Unix timestamp format.
-- The number of timestamps always matches the number of values and the
-- value for Timestamps[x] is Values[x].
--
-- 'values', 'metricDataResult_values' - The data points for the metric corresponding to @Timestamps@. The number
-- of values always matches the number of timestamps and the timestamp for
-- Values[x] is Timestamps[x].
newMetricDataResult ::
  MetricDataResult
newMetricDataResult :: MetricDataResult
newMetricDataResult =
  MetricDataResult'
    { $sel:id:MetricDataResult' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:label:MetricDataResult' :: Maybe Text
label = forall a. Maybe a
Prelude.Nothing,
      $sel:messages:MetricDataResult' :: Maybe [MessageData]
messages = forall a. Maybe a
Prelude.Nothing,
      $sel:statusCode:MetricDataResult' :: Maybe StatusCode
statusCode = forall a. Maybe a
Prelude.Nothing,
      $sel:timestamps:MetricDataResult' :: Maybe [ISO8601]
timestamps = forall a. Maybe a
Prelude.Nothing,
      $sel:values:MetricDataResult' :: Maybe [Double]
values = forall a. Maybe a
Prelude.Nothing
    }

-- | The short name you specified to represent this metric.
metricDataResult_id :: Lens.Lens' MetricDataResult (Prelude.Maybe Prelude.Text)
metricDataResult_id :: Lens' MetricDataResult (Maybe Text)
metricDataResult_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe Text
id :: Maybe Text
$sel:id:MetricDataResult' :: MetricDataResult -> Maybe Text
id} -> Maybe Text
id) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe Text
a -> MetricDataResult
s {$sel:id:MetricDataResult' :: Maybe Text
id = Maybe Text
a} :: MetricDataResult)

-- | The human-readable label associated with the data.
metricDataResult_label :: Lens.Lens' MetricDataResult (Prelude.Maybe Prelude.Text)
metricDataResult_label :: Lens' MetricDataResult (Maybe Text)
metricDataResult_label = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe Text
label :: Maybe Text
$sel:label:MetricDataResult' :: MetricDataResult -> Maybe Text
label} -> Maybe Text
label) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe Text
a -> MetricDataResult
s {$sel:label:MetricDataResult' :: Maybe Text
label = Maybe Text
a} :: MetricDataResult)

-- | A list of messages with additional information about the data returned.
metricDataResult_messages :: Lens.Lens' MetricDataResult (Prelude.Maybe [MessageData])
metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData])
metricDataResult_messages = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe [MessageData]
messages :: Maybe [MessageData]
$sel:messages:MetricDataResult' :: MetricDataResult -> Maybe [MessageData]
messages} -> Maybe [MessageData]
messages) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe [MessageData]
a -> MetricDataResult
s {$sel:messages:MetricDataResult' :: Maybe [MessageData]
messages = Maybe [MessageData]
a} :: MetricDataResult) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The status of the returned data. @Complete@ indicates that all data
-- points in the requested time range were returned. @PartialData@ means
-- that an incomplete set of data points were returned. You can use the
-- @NextToken@ value that was returned and repeat your request to get more
-- data points. @NextToken@ is not returned if you are performing a math
-- expression. @InternalError@ indicates that an error occurred. Retry your
-- request using @NextToken@, if present.
metricDataResult_statusCode :: Lens.Lens' MetricDataResult (Prelude.Maybe StatusCode)
metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode)
metricDataResult_statusCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe StatusCode
statusCode :: Maybe StatusCode
$sel:statusCode:MetricDataResult' :: MetricDataResult -> Maybe StatusCode
statusCode} -> Maybe StatusCode
statusCode) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe StatusCode
a -> MetricDataResult
s {$sel:statusCode:MetricDataResult' :: Maybe StatusCode
statusCode = Maybe StatusCode
a} :: MetricDataResult)

-- | The timestamps for the data points, formatted in Unix timestamp format.
-- The number of timestamps always matches the number of values and the
-- value for Timestamps[x] is Values[x].
metricDataResult_timestamps :: Lens.Lens' MetricDataResult (Prelude.Maybe [Prelude.UTCTime])
metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime])
metricDataResult_timestamps = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe [ISO8601]
timestamps :: Maybe [ISO8601]
$sel:timestamps:MetricDataResult' :: MetricDataResult -> Maybe [ISO8601]
timestamps} -> Maybe [ISO8601]
timestamps) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe [ISO8601]
a -> MetricDataResult
s {$sel:timestamps:MetricDataResult' :: Maybe [ISO8601]
timestamps = Maybe [ISO8601]
a} :: MetricDataResult) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The data points for the metric corresponding to @Timestamps@. The number
-- of values always matches the number of timestamps and the timestamp for
-- Values[x] is Timestamps[x].
metricDataResult_values :: Lens.Lens' MetricDataResult (Prelude.Maybe [Prelude.Double])
metricDataResult_values :: Lens' MetricDataResult (Maybe [Double])
metricDataResult_values = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDataResult' {Maybe [Double]
values :: Maybe [Double]
$sel:values:MetricDataResult' :: MetricDataResult -> Maybe [Double]
values} -> Maybe [Double]
values) (\s :: MetricDataResult
s@MetricDataResult' {} Maybe [Double]
a -> MetricDataResult
s {$sel:values:MetricDataResult' :: Maybe [Double]
values = Maybe [Double]
a} :: MetricDataResult) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromXML MetricDataResult where
  parseXML :: [Node] -> Either String MetricDataResult
parseXML [Node]
x =
    Maybe Text
-> Maybe Text
-> Maybe [MessageData]
-> Maybe StatusCode
-> Maybe [ISO8601]
-> Maybe [Double]
-> MetricDataResult
MetricDataResult'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Id")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Label")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Messages"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"StatusCode")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Timestamps"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Values"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                  )

instance Prelude.Hashable MetricDataResult where
  hashWithSalt :: Int -> MetricDataResult -> Int
hashWithSalt Int
_salt MetricDataResult' {Maybe [Double]
Maybe [ISO8601]
Maybe [MessageData]
Maybe Text
Maybe StatusCode
values :: Maybe [Double]
timestamps :: Maybe [ISO8601]
statusCode :: Maybe StatusCode
messages :: Maybe [MessageData]
label :: Maybe Text
id :: Maybe Text
$sel:values:MetricDataResult' :: MetricDataResult -> Maybe [Double]
$sel:timestamps:MetricDataResult' :: MetricDataResult -> Maybe [ISO8601]
$sel:statusCode:MetricDataResult' :: MetricDataResult -> Maybe StatusCode
$sel:messages:MetricDataResult' :: MetricDataResult -> Maybe [MessageData]
$sel:label:MetricDataResult' :: MetricDataResult -> Maybe Text
$sel:id:MetricDataResult' :: MetricDataResult -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
label
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [MessageData]
messages
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe StatusCode
statusCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ISO8601]
timestamps
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Double]
values

instance Prelude.NFData MetricDataResult where
  rnf :: MetricDataResult -> ()
rnf MetricDataResult' {Maybe [Double]
Maybe [ISO8601]
Maybe [MessageData]
Maybe Text
Maybe StatusCode
values :: Maybe [Double]
timestamps :: Maybe [ISO8601]
statusCode :: Maybe StatusCode
messages :: Maybe [MessageData]
label :: Maybe Text
id :: Maybe Text
$sel:values:MetricDataResult' :: MetricDataResult -> Maybe [Double]
$sel:timestamps:MetricDataResult' :: MetricDataResult -> Maybe [ISO8601]
$sel:statusCode:MetricDataResult' :: MetricDataResult -> Maybe StatusCode
$sel:messages:MetricDataResult' :: MetricDataResult -> Maybe [MessageData]
$sel:label:MetricDataResult' :: MetricDataResult -> Maybe Text
$sel:id:MetricDataResult' :: MetricDataResult -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
label
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [MessageData]
messages
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe StatusCode
statusCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ISO8601]
timestamps
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Double]
values