{-# 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.APIGateway.Types.Usage
-- 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.APIGateway.Types.Usage where

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

-- | Represents the usage data of a usage plan.
--
-- /See:/ 'newUsage' smart constructor.
data Usage = Usage'
  { -- | The ending date of the usage data.
    Usage -> Maybe Text
endDate :: Prelude.Maybe Prelude.Text,
    -- | The usage data, as daily logs of used and remaining quotas, over the
    -- specified time interval indexed over the API keys in a usage plan. For
    -- example,
    -- @{..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}@,
    -- where @{api_key}@ stands for an API key value and the daily log entry is
    -- of the format @[used quota, remaining quota]@.
    Usage -> Maybe (HashMap Text [[Integer]])
items :: Prelude.Maybe (Prelude.HashMap Prelude.Text [[Prelude.Integer]]),
    Usage -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The starting date of the usage data.
    Usage -> Maybe Text
startDate :: Prelude.Maybe Prelude.Text,
    -- | The plan Id associated with this usage data.
    Usage -> Maybe Text
usagePlanId :: Prelude.Maybe Prelude.Text
  }
  deriving (Usage -> Usage -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Usage -> Usage -> Bool
$c/= :: Usage -> Usage -> Bool
== :: Usage -> Usage -> Bool
$c== :: Usage -> Usage -> Bool
Prelude.Eq, ReadPrec [Usage]
ReadPrec Usage
Int -> ReadS Usage
ReadS [Usage]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Usage]
$creadListPrec :: ReadPrec [Usage]
readPrec :: ReadPrec Usage
$creadPrec :: ReadPrec Usage
readList :: ReadS [Usage]
$creadList :: ReadS [Usage]
readsPrec :: Int -> ReadS Usage
$creadsPrec :: Int -> ReadS Usage
Prelude.Read, Int -> Usage -> ShowS
[Usage] -> ShowS
Usage -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Usage] -> ShowS
$cshowList :: [Usage] -> ShowS
show :: Usage -> String
$cshow :: Usage -> String
showsPrec :: Int -> Usage -> ShowS
$cshowsPrec :: Int -> Usage -> ShowS
Prelude.Show, forall x. Rep Usage x -> Usage
forall x. Usage -> Rep Usage x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Usage x -> Usage
$cfrom :: forall x. Usage -> Rep Usage x
Prelude.Generic)

-- |
-- Create a value of 'Usage' 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:
--
-- 'endDate', 'usage_endDate' - The ending date of the usage data.
--
-- 'items', 'usage_items' - The usage data, as daily logs of used and remaining quotas, over the
-- specified time interval indexed over the API keys in a usage plan. For
-- example,
-- @{..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}@,
-- where @{api_key}@ stands for an API key value and the daily log entry is
-- of the format @[used quota, remaining quota]@.
--
-- 'position', 'usage_position' - Undocumented member.
--
-- 'startDate', 'usage_startDate' - The starting date of the usage data.
--
-- 'usagePlanId', 'usage_usagePlanId' - The plan Id associated with this usage data.
newUsage ::
  Usage
newUsage :: Usage
newUsage =
  Usage'
    { $sel:endDate:Usage' :: Maybe Text
endDate = forall a. Maybe a
Prelude.Nothing,
      $sel:items:Usage' :: Maybe (HashMap Text [[Integer]])
items = forall a. Maybe a
Prelude.Nothing,
      $sel:position:Usage' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:startDate:Usage' :: Maybe Text
startDate = forall a. Maybe a
Prelude.Nothing,
      $sel:usagePlanId:Usage' :: Maybe Text
usagePlanId = forall a. Maybe a
Prelude.Nothing
    }

-- | The ending date of the usage data.
usage_endDate :: Lens.Lens' Usage (Prelude.Maybe Prelude.Text)
usage_endDate :: Lens' Usage (Maybe Text)
usage_endDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Usage' {Maybe Text
endDate :: Maybe Text
$sel:endDate:Usage' :: Usage -> Maybe Text
endDate} -> Maybe Text
endDate) (\s :: Usage
s@Usage' {} Maybe Text
a -> Usage
s {$sel:endDate:Usage' :: Maybe Text
endDate = Maybe Text
a} :: Usage)

-- | The usage data, as daily logs of used and remaining quotas, over the
-- specified time interval indexed over the API keys in a usage plan. For
-- example,
-- @{..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}@,
-- where @{api_key}@ stands for an API key value and the daily log entry is
-- of the format @[used quota, remaining quota]@.
usage_items :: Lens.Lens' Usage (Prelude.Maybe (Prelude.HashMap Prelude.Text [[Prelude.Integer]]))
usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]]))
usage_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Usage' {Maybe (HashMap Text [[Integer]])
items :: Maybe (HashMap Text [[Integer]])
$sel:items:Usage' :: Usage -> Maybe (HashMap Text [[Integer]])
items} -> Maybe (HashMap Text [[Integer]])
items) (\s :: Usage
s@Usage' {} Maybe (HashMap Text [[Integer]])
a -> Usage
s {$sel:items:Usage' :: Maybe (HashMap Text [[Integer]])
items = Maybe (HashMap Text [[Integer]])
a} :: Usage) 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

-- | Undocumented member.
usage_position :: Lens.Lens' Usage (Prelude.Maybe Prelude.Text)
usage_position :: Lens' Usage (Maybe Text)
usage_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Usage' {Maybe Text
position :: Maybe Text
$sel:position:Usage' :: Usage -> Maybe Text
position} -> Maybe Text
position) (\s :: Usage
s@Usage' {} Maybe Text
a -> Usage
s {$sel:position:Usage' :: Maybe Text
position = Maybe Text
a} :: Usage)

-- | The starting date of the usage data.
usage_startDate :: Lens.Lens' Usage (Prelude.Maybe Prelude.Text)
usage_startDate :: Lens' Usage (Maybe Text)
usage_startDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Usage' {Maybe Text
startDate :: Maybe Text
$sel:startDate:Usage' :: Usage -> Maybe Text
startDate} -> Maybe Text
startDate) (\s :: Usage
s@Usage' {} Maybe Text
a -> Usage
s {$sel:startDate:Usage' :: Maybe Text
startDate = Maybe Text
a} :: Usage)

-- | The plan Id associated with this usage data.
usage_usagePlanId :: Lens.Lens' Usage (Prelude.Maybe Prelude.Text)
usage_usagePlanId :: Lens' Usage (Maybe Text)
usage_usagePlanId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Usage' {Maybe Text
usagePlanId :: Maybe Text
$sel:usagePlanId:Usage' :: Usage -> Maybe Text
usagePlanId} -> Maybe Text
usagePlanId) (\s :: Usage
s@Usage' {} Maybe Text
a -> Usage
s {$sel:usagePlanId:Usage' :: Maybe Text
usagePlanId = Maybe Text
a} :: Usage)

instance Data.FromJSON Usage where
  parseJSON :: Value -> Parser Usage
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Usage"
      ( \Object
x ->
          Maybe Text
-> Maybe (HashMap Text [[Integer]])
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Usage
Usage'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"endDate")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"values" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"position")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"startDate")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"usagePlanId")
      )

instance Prelude.Hashable Usage where
  hashWithSalt :: Int -> Usage -> Int
hashWithSalt Int
_salt Usage' {Maybe Text
Maybe (HashMap Text [[Integer]])
usagePlanId :: Maybe Text
startDate :: Maybe Text
position :: Maybe Text
items :: Maybe (HashMap Text [[Integer]])
endDate :: Maybe Text
$sel:usagePlanId:Usage' :: Usage -> Maybe Text
$sel:startDate:Usage' :: Usage -> Maybe Text
$sel:position:Usage' :: Usage -> Maybe Text
$sel:items:Usage' :: Usage -> Maybe (HashMap Text [[Integer]])
$sel:endDate:Usage' :: Usage -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
endDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text [[Integer]])
items
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
position
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
startDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
usagePlanId

instance Prelude.NFData Usage where
  rnf :: Usage -> ()
rnf Usage' {Maybe Text
Maybe (HashMap Text [[Integer]])
usagePlanId :: Maybe Text
startDate :: Maybe Text
position :: Maybe Text
items :: Maybe (HashMap Text [[Integer]])
endDate :: Maybe Text
$sel:usagePlanId:Usage' :: Usage -> Maybe Text
$sel:startDate:Usage' :: Usage -> Maybe Text
$sel:position:Usage' :: Usage -> Maybe Text
$sel:items:Usage' :: Usage -> Maybe (HashMap Text [[Integer]])
$sel:endDate:Usage' :: Usage -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
endDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text [[Integer]])
items
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
position
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
startDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
usagePlanId