{-# 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.CloudWatchLogs.Types.QueryDefinition
-- 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.CloudWatchLogs.Types.QueryDefinition 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

-- | This structure contains details about a saved CloudWatch Logs Insights
-- query definition.
--
-- /See:/ 'newQueryDefinition' smart constructor.
data QueryDefinition = QueryDefinition'
  { -- | The date that the query definition was most recently modified.
    QueryDefinition -> Maybe Natural
lastModified :: Prelude.Maybe Prelude.Natural,
    -- | If this query definition contains a list of log groups that it is
    -- limited to, that list appears here.
    QueryDefinition -> Maybe [Text]
logGroupNames :: Prelude.Maybe [Prelude.Text],
    -- | The name of the query definition.
    QueryDefinition -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The unique ID of the query definition.
    QueryDefinition -> Maybe Text
queryDefinitionId :: Prelude.Maybe Prelude.Text,
    -- | The query string to use for this definition. For more information, see
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html CloudWatch Logs Insights Query Syntax>.
    QueryDefinition -> Maybe Text
queryString :: Prelude.Maybe Prelude.Text
  }
  deriving (QueryDefinition -> QueryDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryDefinition -> QueryDefinition -> Bool
$c/= :: QueryDefinition -> QueryDefinition -> Bool
== :: QueryDefinition -> QueryDefinition -> Bool
$c== :: QueryDefinition -> QueryDefinition -> Bool
Prelude.Eq, ReadPrec [QueryDefinition]
ReadPrec QueryDefinition
Int -> ReadS QueryDefinition
ReadS [QueryDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryDefinition]
$creadListPrec :: ReadPrec [QueryDefinition]
readPrec :: ReadPrec QueryDefinition
$creadPrec :: ReadPrec QueryDefinition
readList :: ReadS [QueryDefinition]
$creadList :: ReadS [QueryDefinition]
readsPrec :: Int -> ReadS QueryDefinition
$creadsPrec :: Int -> ReadS QueryDefinition
Prelude.Read, Int -> QueryDefinition -> ShowS
[QueryDefinition] -> ShowS
QueryDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryDefinition] -> ShowS
$cshowList :: [QueryDefinition] -> ShowS
show :: QueryDefinition -> String
$cshow :: QueryDefinition -> String
showsPrec :: Int -> QueryDefinition -> ShowS
$cshowsPrec :: Int -> QueryDefinition -> ShowS
Prelude.Show, forall x. Rep QueryDefinition x -> QueryDefinition
forall x. QueryDefinition -> Rep QueryDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep QueryDefinition x -> QueryDefinition
$cfrom :: forall x. QueryDefinition -> Rep QueryDefinition x
Prelude.Generic)

-- |
-- Create a value of 'QueryDefinition' 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:
--
-- 'lastModified', 'queryDefinition_lastModified' - The date that the query definition was most recently modified.
--
-- 'logGroupNames', 'queryDefinition_logGroupNames' - If this query definition contains a list of log groups that it is
-- limited to, that list appears here.
--
-- 'name', 'queryDefinition_name' - The name of the query definition.
--
-- 'queryDefinitionId', 'queryDefinition_queryDefinitionId' - The unique ID of the query definition.
--
-- 'queryString', 'queryDefinition_queryString' - The query string to use for this definition. For more information, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html CloudWatch Logs Insights Query Syntax>.
newQueryDefinition ::
  QueryDefinition
newQueryDefinition :: QueryDefinition
newQueryDefinition =
  QueryDefinition'
    { $sel:lastModified:QueryDefinition' :: Maybe Natural
lastModified = forall a. Maybe a
Prelude.Nothing,
      $sel:logGroupNames:QueryDefinition' :: Maybe [Text]
logGroupNames = forall a. Maybe a
Prelude.Nothing,
      $sel:name:QueryDefinition' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:queryDefinitionId:QueryDefinition' :: Maybe Text
queryDefinitionId = forall a. Maybe a
Prelude.Nothing,
      $sel:queryString:QueryDefinition' :: Maybe Text
queryString = forall a. Maybe a
Prelude.Nothing
    }

-- | The date that the query definition was most recently modified.
queryDefinition_lastModified :: Lens.Lens' QueryDefinition (Prelude.Maybe Prelude.Natural)
queryDefinition_lastModified :: Lens' QueryDefinition (Maybe Natural)
queryDefinition_lastModified = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryDefinition' {Maybe Natural
lastModified :: Maybe Natural
$sel:lastModified:QueryDefinition' :: QueryDefinition -> Maybe Natural
lastModified} -> Maybe Natural
lastModified) (\s :: QueryDefinition
s@QueryDefinition' {} Maybe Natural
a -> QueryDefinition
s {$sel:lastModified:QueryDefinition' :: Maybe Natural
lastModified = Maybe Natural
a} :: QueryDefinition)

-- | If this query definition contains a list of log groups that it is
-- limited to, that list appears here.
queryDefinition_logGroupNames :: Lens.Lens' QueryDefinition (Prelude.Maybe [Prelude.Text])
queryDefinition_logGroupNames :: Lens' QueryDefinition (Maybe [Text])
queryDefinition_logGroupNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryDefinition' {Maybe [Text]
logGroupNames :: Maybe [Text]
$sel:logGroupNames:QueryDefinition' :: QueryDefinition -> Maybe [Text]
logGroupNames} -> Maybe [Text]
logGroupNames) (\s :: QueryDefinition
s@QueryDefinition' {} Maybe [Text]
a -> QueryDefinition
s {$sel:logGroupNames:QueryDefinition' :: Maybe [Text]
logGroupNames = Maybe [Text]
a} :: QueryDefinition) 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 name of the query definition.
queryDefinition_name :: Lens.Lens' QueryDefinition (Prelude.Maybe Prelude.Text)
queryDefinition_name :: Lens' QueryDefinition (Maybe Text)
queryDefinition_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryDefinition' {Maybe Text
name :: Maybe Text
$sel:name:QueryDefinition' :: QueryDefinition -> Maybe Text
name} -> Maybe Text
name) (\s :: QueryDefinition
s@QueryDefinition' {} Maybe Text
a -> QueryDefinition
s {$sel:name:QueryDefinition' :: Maybe Text
name = Maybe Text
a} :: QueryDefinition)

-- | The unique ID of the query definition.
queryDefinition_queryDefinitionId :: Lens.Lens' QueryDefinition (Prelude.Maybe Prelude.Text)
queryDefinition_queryDefinitionId :: Lens' QueryDefinition (Maybe Text)
queryDefinition_queryDefinitionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryDefinition' {Maybe Text
queryDefinitionId :: Maybe Text
$sel:queryDefinitionId:QueryDefinition' :: QueryDefinition -> Maybe Text
queryDefinitionId} -> Maybe Text
queryDefinitionId) (\s :: QueryDefinition
s@QueryDefinition' {} Maybe Text
a -> QueryDefinition
s {$sel:queryDefinitionId:QueryDefinition' :: Maybe Text
queryDefinitionId = Maybe Text
a} :: QueryDefinition)

-- | The query string to use for this definition. For more information, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html CloudWatch Logs Insights Query Syntax>.
queryDefinition_queryString :: Lens.Lens' QueryDefinition (Prelude.Maybe Prelude.Text)
queryDefinition_queryString :: Lens' QueryDefinition (Maybe Text)
queryDefinition_queryString = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryDefinition' {Maybe Text
queryString :: Maybe Text
$sel:queryString:QueryDefinition' :: QueryDefinition -> Maybe Text
queryString} -> Maybe Text
queryString) (\s :: QueryDefinition
s@QueryDefinition' {} Maybe Text
a -> QueryDefinition
s {$sel:queryString:QueryDefinition' :: Maybe Text
queryString = Maybe Text
a} :: QueryDefinition)

instance Data.FromJSON QueryDefinition where
  parseJSON :: Value -> Parser QueryDefinition
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"QueryDefinition"
      ( \Object
x ->
          Maybe Natural
-> Maybe [Text]
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> QueryDefinition
QueryDefinition'
            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
"lastModified")
            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
"logGroupNames" 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
"name")
            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
"queryDefinitionId")
            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
"queryString")
      )

instance Prelude.Hashable QueryDefinition where
  hashWithSalt :: Int -> QueryDefinition -> Int
hashWithSalt Int
_salt QueryDefinition' {Maybe Natural
Maybe [Text]
Maybe Text
queryString :: Maybe Text
queryDefinitionId :: Maybe Text
name :: Maybe Text
logGroupNames :: Maybe [Text]
lastModified :: Maybe Natural
$sel:queryString:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:queryDefinitionId:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:name:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:logGroupNames:QueryDefinition' :: QueryDefinition -> Maybe [Text]
$sel:lastModified:QueryDefinition' :: QueryDefinition -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
lastModified
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
logGroupNames
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
queryDefinitionId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
queryString

instance Prelude.NFData QueryDefinition where
  rnf :: QueryDefinition -> ()
rnf QueryDefinition' {Maybe Natural
Maybe [Text]
Maybe Text
queryString :: Maybe Text
queryDefinitionId :: Maybe Text
name :: Maybe Text
logGroupNames :: Maybe [Text]
lastModified :: Maybe Natural
$sel:queryString:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:queryDefinitionId:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:name:QueryDefinition' :: QueryDefinition -> Maybe Text
$sel:logGroupNames:QueryDefinition' :: QueryDefinition -> Maybe [Text]
$sel:lastModified:QueryDefinition' :: QueryDefinition -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
lastModified
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
logGroupNames
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
queryDefinitionId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
queryString