{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# 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.GetModels
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes existing Models defined for a RestApi resource.
--
-- This operation returns paginated results.
module Amazonka.APIGateway.GetModels
  ( -- * Creating a Request
    GetModels (..),
    newGetModels,

    -- * Request Lenses
    getModels_limit,
    getModels_position,
    getModels_restApiId,

    -- * Destructuring the Response
    GetModelsResponse (..),
    newGetModelsResponse,

    -- * Response Lenses
    getModelsResponse_items,
    getModelsResponse_position,
    getModelsResponse_httpStatus,
  )
where

import Amazonka.APIGateway.Types
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
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Request to list existing Models defined for a RestApi resource.
--
-- /See:/ 'newGetModels' smart constructor.
data GetModels = GetModels'
  { -- | The maximum number of returned results per page. The default value is 25
    -- and the maximum value is 500.
    GetModels -> Maybe Int
limit :: Prelude.Maybe Prelude.Int,
    -- | The current pagination position in the paged result set.
    GetModels -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The string identifier of the associated RestApi.
    GetModels -> Text
restApiId :: Prelude.Text
  }
  deriving (GetModels -> GetModels -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetModels -> GetModels -> Bool
$c/= :: GetModels -> GetModels -> Bool
== :: GetModels -> GetModels -> Bool
$c== :: GetModels -> GetModels -> Bool
Prelude.Eq, ReadPrec [GetModels]
ReadPrec GetModels
Int -> ReadS GetModels
ReadS [GetModels]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetModels]
$creadListPrec :: ReadPrec [GetModels]
readPrec :: ReadPrec GetModels
$creadPrec :: ReadPrec GetModels
readList :: ReadS [GetModels]
$creadList :: ReadS [GetModels]
readsPrec :: Int -> ReadS GetModels
$creadsPrec :: Int -> ReadS GetModels
Prelude.Read, Int -> GetModels -> ShowS
[GetModels] -> ShowS
GetModels -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetModels] -> ShowS
$cshowList :: [GetModels] -> ShowS
show :: GetModels -> String
$cshow :: GetModels -> String
showsPrec :: Int -> GetModels -> ShowS
$cshowsPrec :: Int -> GetModels -> ShowS
Prelude.Show, forall x. Rep GetModels x -> GetModels
forall x. GetModels -> Rep GetModels x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetModels x -> GetModels
$cfrom :: forall x. GetModels -> Rep GetModels x
Prelude.Generic)

-- |
-- Create a value of 'GetModels' 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:
--
-- 'limit', 'getModels_limit' - The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
--
-- 'position', 'getModels_position' - The current pagination position in the paged result set.
--
-- 'restApiId', 'getModels_restApiId' - The string identifier of the associated RestApi.
newGetModels ::
  -- | 'restApiId'
  Prelude.Text ->
  GetModels
newGetModels :: Text -> GetModels
newGetModels Text
pRestApiId_ =
  GetModels'
    { $sel:limit:GetModels' :: Maybe Int
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetModels' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:restApiId:GetModels' :: Text
restApiId = Text
pRestApiId_
    }

-- | The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
getModels_limit :: Lens.Lens' GetModels (Prelude.Maybe Prelude.Int)
getModels_limit :: Lens' GetModels (Maybe Int)
getModels_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModels' {Maybe Int
limit :: Maybe Int
$sel:limit:GetModels' :: GetModels -> Maybe Int
limit} -> Maybe Int
limit) (\s :: GetModels
s@GetModels' {} Maybe Int
a -> GetModels
s {$sel:limit:GetModels' :: Maybe Int
limit = Maybe Int
a} :: GetModels)

-- | The current pagination position in the paged result set.
getModels_position :: Lens.Lens' GetModels (Prelude.Maybe Prelude.Text)
getModels_position :: Lens' GetModels (Maybe Text)
getModels_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModels' {Maybe Text
position :: Maybe Text
$sel:position:GetModels' :: GetModels -> Maybe Text
position} -> Maybe Text
position) (\s :: GetModels
s@GetModels' {} Maybe Text
a -> GetModels
s {$sel:position:GetModels' :: Maybe Text
position = Maybe Text
a} :: GetModels)

-- | The string identifier of the associated RestApi.
getModels_restApiId :: Lens.Lens' GetModels Prelude.Text
getModels_restApiId :: Lens' GetModels Text
getModels_restApiId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModels' {Text
restApiId :: Text
$sel:restApiId:GetModels' :: GetModels -> Text
restApiId} -> Text
restApiId) (\s :: GetModels
s@GetModels' {} Text
a -> GetModels
s {$sel:restApiId:GetModels' :: Text
restApiId = Text
a} :: GetModels)

instance Core.AWSPager GetModels where
  page :: GetModels -> AWSResponse GetModels -> Maybe GetModels
page GetModels
rq AWSResponse GetModels
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetModels
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetModelsResponse (Maybe Text)
getModelsResponse_position
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetModels
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetModelsResponse (Maybe [Model])
getModelsResponse_items
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ GetModels
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetModels (Maybe Text)
getModels_position
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetModels
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetModelsResponse (Maybe Text)
getModelsResponse_position
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest GetModels where
  type AWSResponse GetModels = GetModelsResponse
  request :: (Service -> Service) -> GetModels -> Request GetModels
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetModels
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetModels)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [Model] -> Maybe Text -> Int -> GetModelsResponse
GetModelsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"item" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ 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 -> Either String (Maybe a)
Data..?> Key
"position")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetModels where
  hashWithSalt :: Int -> GetModels -> Int
hashWithSalt Int
_salt GetModels' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetModels' :: GetModels -> Text
$sel:position:GetModels' :: GetModels -> Maybe Text
$sel:limit:GetModels' :: GetModels -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
position
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
restApiId

instance Prelude.NFData GetModels where
  rnf :: GetModels -> ()
rnf GetModels' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetModels' :: GetModels -> Text
$sel:position:GetModels' :: GetModels -> Maybe Text
$sel:limit:GetModels' :: GetModels -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
limit
      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 Text
restApiId

instance Data.ToHeaders GetModels where
  toHeaders :: GetModels -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Accept"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"application/json" :: Prelude.ByteString)
          ]
      )

instance Data.ToPath GetModels where
  toPath :: GetModels -> ByteString
toPath GetModels' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetModels' :: GetModels -> Text
$sel:position:GetModels' :: GetModels -> Maybe Text
$sel:limit:GetModels' :: GetModels -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/restapis/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
restApiId, ByteString
"/models"]

instance Data.ToQuery GetModels where
  toQuery :: GetModels -> QueryString
toQuery GetModels' {Maybe Int
Maybe Text
Text
restApiId :: Text
position :: Maybe Text
limit :: Maybe Int
$sel:restApiId:GetModels' :: GetModels -> Text
$sel:position:GetModels' :: GetModels -> Maybe Text
$sel:limit:GetModels' :: GetModels -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"limit" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Int
limit, ByteString
"position" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
position]

-- | Represents a collection of Model resources.
--
-- /See:/ 'newGetModelsResponse' smart constructor.
data GetModelsResponse = GetModelsResponse'
  { -- | The current page of elements from this collection.
    GetModelsResponse -> Maybe [Model]
items :: Prelude.Maybe [Model],
    GetModelsResponse -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetModelsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetModelsResponse -> GetModelsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetModelsResponse -> GetModelsResponse -> Bool
$c/= :: GetModelsResponse -> GetModelsResponse -> Bool
== :: GetModelsResponse -> GetModelsResponse -> Bool
$c== :: GetModelsResponse -> GetModelsResponse -> Bool
Prelude.Eq, ReadPrec [GetModelsResponse]
ReadPrec GetModelsResponse
Int -> ReadS GetModelsResponse
ReadS [GetModelsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetModelsResponse]
$creadListPrec :: ReadPrec [GetModelsResponse]
readPrec :: ReadPrec GetModelsResponse
$creadPrec :: ReadPrec GetModelsResponse
readList :: ReadS [GetModelsResponse]
$creadList :: ReadS [GetModelsResponse]
readsPrec :: Int -> ReadS GetModelsResponse
$creadsPrec :: Int -> ReadS GetModelsResponse
Prelude.Read, Int -> GetModelsResponse -> ShowS
[GetModelsResponse] -> ShowS
GetModelsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetModelsResponse] -> ShowS
$cshowList :: [GetModelsResponse] -> ShowS
show :: GetModelsResponse -> String
$cshow :: GetModelsResponse -> String
showsPrec :: Int -> GetModelsResponse -> ShowS
$cshowsPrec :: Int -> GetModelsResponse -> ShowS
Prelude.Show, forall x. Rep GetModelsResponse x -> GetModelsResponse
forall x. GetModelsResponse -> Rep GetModelsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetModelsResponse x -> GetModelsResponse
$cfrom :: forall x. GetModelsResponse -> Rep GetModelsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetModelsResponse' 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:
--
-- 'items', 'getModelsResponse_items' - The current page of elements from this collection.
--
-- 'position', 'getModelsResponse_position' - Undocumented member.
--
-- 'httpStatus', 'getModelsResponse_httpStatus' - The response's http status code.
newGetModelsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetModelsResponse
newGetModelsResponse :: Int -> GetModelsResponse
newGetModelsResponse Int
pHttpStatus_ =
  GetModelsResponse'
    { $sel:items:GetModelsResponse' :: Maybe [Model]
items = forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetModelsResponse' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetModelsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The current page of elements from this collection.
getModelsResponse_items :: Lens.Lens' GetModelsResponse (Prelude.Maybe [Model])
getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model])
getModelsResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModelsResponse' {Maybe [Model]
items :: Maybe [Model]
$sel:items:GetModelsResponse' :: GetModelsResponse -> Maybe [Model]
items} -> Maybe [Model]
items) (\s :: GetModelsResponse
s@GetModelsResponse' {} Maybe [Model]
a -> GetModelsResponse
s {$sel:items:GetModelsResponse' :: Maybe [Model]
items = Maybe [Model]
a} :: GetModelsResponse) 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.
getModelsResponse_position :: Lens.Lens' GetModelsResponse (Prelude.Maybe Prelude.Text)
getModelsResponse_position :: Lens' GetModelsResponse (Maybe Text)
getModelsResponse_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModelsResponse' {Maybe Text
position :: Maybe Text
$sel:position:GetModelsResponse' :: GetModelsResponse -> Maybe Text
position} -> Maybe Text
position) (\s :: GetModelsResponse
s@GetModelsResponse' {} Maybe Text
a -> GetModelsResponse
s {$sel:position:GetModelsResponse' :: Maybe Text
position = Maybe Text
a} :: GetModelsResponse)

-- | The response's http status code.
getModelsResponse_httpStatus :: Lens.Lens' GetModelsResponse Prelude.Int
getModelsResponse_httpStatus :: Lens' GetModelsResponse Int
getModelsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetModelsResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetModelsResponse' :: GetModelsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetModelsResponse
s@GetModelsResponse' {} Int
a -> GetModelsResponse
s {$sel:httpStatus:GetModelsResponse' :: Int
httpStatus = Int
a} :: GetModelsResponse)

instance Prelude.NFData GetModelsResponse where
  rnf :: GetModelsResponse -> ()
rnf GetModelsResponse' {Int
Maybe [Model]
Maybe Text
httpStatus :: Int
position :: Maybe Text
items :: Maybe [Model]
$sel:httpStatus:GetModelsResponse' :: GetModelsResponse -> Int
$sel:position:GetModelsResponse' :: GetModelsResponse -> Maybe Text
$sel:items:GetModelsResponse' :: GetModelsResponse -> Maybe [Model]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Model]
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 Int
httpStatus