{-# 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.Lightsail.Types.QueryStringObject
-- 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.Lightsail.Types.QueryStringObject 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

-- | Describes the query string parameters that an Amazon Lightsail content
-- delivery network (CDN) distribution to bases caching on.
--
-- For the query strings that you specify, your distribution caches
-- separate versions of the specified content based on the query string
-- values in viewer requests.
--
-- /See:/ 'newQueryStringObject' smart constructor.
data QueryStringObject = QueryStringObject'
  { -- | Indicates whether the distribution forwards and caches based on query
    -- strings.
    QueryStringObject -> Maybe Bool
option :: Prelude.Maybe Prelude.Bool,
    -- | The specific query strings that the distribution forwards to the origin.
    --
    -- Your distribution will cache content based on the specified query
    -- strings.
    --
    -- If the @option@ parameter is true, then your distribution forwards all
    -- query strings, regardless of what you specify using the
    -- @queryStringsAllowList@ parameter.
    QueryStringObject -> Maybe [Text]
queryStringsAllowList :: Prelude.Maybe [Prelude.Text]
  }
  deriving (QueryStringObject -> QueryStringObject -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryStringObject -> QueryStringObject -> Bool
$c/= :: QueryStringObject -> QueryStringObject -> Bool
== :: QueryStringObject -> QueryStringObject -> Bool
$c== :: QueryStringObject -> QueryStringObject -> Bool
Prelude.Eq, ReadPrec [QueryStringObject]
ReadPrec QueryStringObject
Int -> ReadS QueryStringObject
ReadS [QueryStringObject]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryStringObject]
$creadListPrec :: ReadPrec [QueryStringObject]
readPrec :: ReadPrec QueryStringObject
$creadPrec :: ReadPrec QueryStringObject
readList :: ReadS [QueryStringObject]
$creadList :: ReadS [QueryStringObject]
readsPrec :: Int -> ReadS QueryStringObject
$creadsPrec :: Int -> ReadS QueryStringObject
Prelude.Read, Int -> QueryStringObject -> ShowS
[QueryStringObject] -> ShowS
QueryStringObject -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryStringObject] -> ShowS
$cshowList :: [QueryStringObject] -> ShowS
show :: QueryStringObject -> String
$cshow :: QueryStringObject -> String
showsPrec :: Int -> QueryStringObject -> ShowS
$cshowsPrec :: Int -> QueryStringObject -> ShowS
Prelude.Show, forall x. Rep QueryStringObject x -> QueryStringObject
forall x. QueryStringObject -> Rep QueryStringObject x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep QueryStringObject x -> QueryStringObject
$cfrom :: forall x. QueryStringObject -> Rep QueryStringObject x
Prelude.Generic)

-- |
-- Create a value of 'QueryStringObject' 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:
--
-- 'option', 'queryStringObject_option' - Indicates whether the distribution forwards and caches based on query
-- strings.
--
-- 'queryStringsAllowList', 'queryStringObject_queryStringsAllowList' - The specific query strings that the distribution forwards to the origin.
--
-- Your distribution will cache content based on the specified query
-- strings.
--
-- If the @option@ parameter is true, then your distribution forwards all
-- query strings, regardless of what you specify using the
-- @queryStringsAllowList@ parameter.
newQueryStringObject ::
  QueryStringObject
newQueryStringObject :: QueryStringObject
newQueryStringObject =
  QueryStringObject'
    { $sel:option:QueryStringObject' :: Maybe Bool
option = forall a. Maybe a
Prelude.Nothing,
      $sel:queryStringsAllowList:QueryStringObject' :: Maybe [Text]
queryStringsAllowList = forall a. Maybe a
Prelude.Nothing
    }

-- | Indicates whether the distribution forwards and caches based on query
-- strings.
queryStringObject_option :: Lens.Lens' QueryStringObject (Prelude.Maybe Prelude.Bool)
queryStringObject_option :: Lens' QueryStringObject (Maybe Bool)
queryStringObject_option = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStringObject' {Maybe Bool
option :: Maybe Bool
$sel:option:QueryStringObject' :: QueryStringObject -> Maybe Bool
option} -> Maybe Bool
option) (\s :: QueryStringObject
s@QueryStringObject' {} Maybe Bool
a -> QueryStringObject
s {$sel:option:QueryStringObject' :: Maybe Bool
option = Maybe Bool
a} :: QueryStringObject)

-- | The specific query strings that the distribution forwards to the origin.
--
-- Your distribution will cache content based on the specified query
-- strings.
--
-- If the @option@ parameter is true, then your distribution forwards all
-- query strings, regardless of what you specify using the
-- @queryStringsAllowList@ parameter.
queryStringObject_queryStringsAllowList :: Lens.Lens' QueryStringObject (Prelude.Maybe [Prelude.Text])
queryStringObject_queryStringsAllowList :: Lens' QueryStringObject (Maybe [Text])
queryStringObject_queryStringsAllowList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStringObject' {Maybe [Text]
queryStringsAllowList :: Maybe [Text]
$sel:queryStringsAllowList:QueryStringObject' :: QueryStringObject -> Maybe [Text]
queryStringsAllowList} -> Maybe [Text]
queryStringsAllowList) (\s :: QueryStringObject
s@QueryStringObject' {} Maybe [Text]
a -> QueryStringObject
s {$sel:queryStringsAllowList:QueryStringObject' :: Maybe [Text]
queryStringsAllowList = Maybe [Text]
a} :: QueryStringObject) 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.FromJSON QueryStringObject where
  parseJSON :: Value -> Parser QueryStringObject
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"QueryStringObject"
      ( \Object
x ->
          Maybe Bool -> Maybe [Text] -> QueryStringObject
QueryStringObject'
            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
"option")
            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
"queryStringsAllowList"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable QueryStringObject where
  hashWithSalt :: Int -> QueryStringObject -> Int
hashWithSalt Int
_salt QueryStringObject' {Maybe Bool
Maybe [Text]
queryStringsAllowList :: Maybe [Text]
option :: Maybe Bool
$sel:queryStringsAllowList:QueryStringObject' :: QueryStringObject -> Maybe [Text]
$sel:option:QueryStringObject' :: QueryStringObject -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
option
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
queryStringsAllowList

instance Prelude.NFData QueryStringObject where
  rnf :: QueryStringObject -> ()
rnf QueryStringObject' {Maybe Bool
Maybe [Text]
queryStringsAllowList :: Maybe [Text]
option :: Maybe Bool
$sel:queryStringsAllowList:QueryStringObject' :: QueryStringObject -> Maybe [Text]
$sel:option:QueryStringObject' :: QueryStringObject -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
option
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
queryStringsAllowList

instance Data.ToJSON QueryStringObject where
  toJSON :: QueryStringObject -> Value
toJSON QueryStringObject' {Maybe Bool
Maybe [Text]
queryStringsAllowList :: Maybe [Text]
option :: Maybe Bool
$sel:queryStringsAllowList:QueryStringObject' :: QueryStringObject -> Maybe [Text]
$sel:option:QueryStringObject' :: QueryStringObject -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"option" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
option,
            (Key
"queryStringsAllowList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
queryStringsAllowList
          ]
      )