{-# 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.DataSync.Types.TaskFilter
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.DataSync.Types.TaskFilter where

import qualified Amazonka.Core as Core
import Amazonka.DataSync.Types.Operator
import Amazonka.DataSync.Types.TaskFilterName
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | You can use API filters to narrow down the list of resources returned by
-- @ListTasks@. For example, to retrieve all tasks on a source location,
-- you can use @ListTasks@ with filter name @LocationId@ and
-- @Operator Equals@ with the ARN for the location.
--
-- /See:/ 'newTaskFilter' smart constructor.
data TaskFilter = TaskFilter'
  { -- | The name of the filter being used. Each API call supports a list of
    -- filters that are available for it. For example, @LocationId@ for
    -- @ListTasks@.
    TaskFilter -> TaskFilterName
name :: TaskFilterName,
    -- | The values that you want to filter for. For example, you might want to
    -- display only tasks for a specific destination location.
    TaskFilter -> [Text]
values :: [Prelude.Text],
    -- | The operator that is used to compare filter values (for example,
    -- @Equals@ or @Contains@). For more about API filtering operators, see
    -- <https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html API filters for ListTasks and ListLocations>.
    TaskFilter -> Operator
operator :: Operator
  }
  deriving (TaskFilter -> TaskFilter -> Bool
(TaskFilter -> TaskFilter -> Bool)
-> (TaskFilter -> TaskFilter -> Bool) -> Eq TaskFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TaskFilter -> TaskFilter -> Bool
$c/= :: TaskFilter -> TaskFilter -> Bool
== :: TaskFilter -> TaskFilter -> Bool
$c== :: TaskFilter -> TaskFilter -> Bool
Prelude.Eq, ReadPrec [TaskFilter]
ReadPrec TaskFilter
Int -> ReadS TaskFilter
ReadS [TaskFilter]
(Int -> ReadS TaskFilter)
-> ReadS [TaskFilter]
-> ReadPrec TaskFilter
-> ReadPrec [TaskFilter]
-> Read TaskFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TaskFilter]
$creadListPrec :: ReadPrec [TaskFilter]
readPrec :: ReadPrec TaskFilter
$creadPrec :: ReadPrec TaskFilter
readList :: ReadS [TaskFilter]
$creadList :: ReadS [TaskFilter]
readsPrec :: Int -> ReadS TaskFilter
$creadsPrec :: Int -> ReadS TaskFilter
Prelude.Read, Int -> TaskFilter -> ShowS
[TaskFilter] -> ShowS
TaskFilter -> String
(Int -> TaskFilter -> ShowS)
-> (TaskFilter -> String)
-> ([TaskFilter] -> ShowS)
-> Show TaskFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TaskFilter] -> ShowS
$cshowList :: [TaskFilter] -> ShowS
show :: TaskFilter -> String
$cshow :: TaskFilter -> String
showsPrec :: Int -> TaskFilter -> ShowS
$cshowsPrec :: Int -> TaskFilter -> ShowS
Prelude.Show, (forall x. TaskFilter -> Rep TaskFilter x)
-> (forall x. Rep TaskFilter x -> TaskFilter) -> Generic TaskFilter
forall x. Rep TaskFilter x -> TaskFilter
forall x. TaskFilter -> Rep TaskFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TaskFilter x -> TaskFilter
$cfrom :: forall x. TaskFilter -> Rep TaskFilter x
Prelude.Generic)

-- |
-- Create a value of 'TaskFilter' 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:
--
-- 'name', 'taskFilter_name' - The name of the filter being used. Each API call supports a list of
-- filters that are available for it. For example, @LocationId@ for
-- @ListTasks@.
--
-- 'values', 'taskFilter_values' - The values that you want to filter for. For example, you might want to
-- display only tasks for a specific destination location.
--
-- 'operator', 'taskFilter_operator' - The operator that is used to compare filter values (for example,
-- @Equals@ or @Contains@). For more about API filtering operators, see
-- <https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html API filters for ListTasks and ListLocations>.
newTaskFilter ::
  -- | 'name'
  TaskFilterName ->
  -- | 'operator'
  Operator ->
  TaskFilter
newTaskFilter :: TaskFilterName -> Operator -> TaskFilter
newTaskFilter TaskFilterName
pName_ Operator
pOperator_ =
  TaskFilter' :: TaskFilterName -> [Text] -> Operator -> TaskFilter
TaskFilter'
    { $sel:name:TaskFilter' :: TaskFilterName
name = TaskFilterName
pName_,
      $sel:values:TaskFilter' :: [Text]
values = [Text]
forall a. Monoid a => a
Prelude.mempty,
      $sel:operator:TaskFilter' :: Operator
operator = Operator
pOperator_
    }

-- | The name of the filter being used. Each API call supports a list of
-- filters that are available for it. For example, @LocationId@ for
-- @ListTasks@.
taskFilter_name :: Lens.Lens' TaskFilter TaskFilterName
taskFilter_name :: (TaskFilterName -> f TaskFilterName) -> TaskFilter -> f TaskFilter
taskFilter_name = (TaskFilter -> TaskFilterName)
-> (TaskFilter -> TaskFilterName -> TaskFilter)
-> Lens TaskFilter TaskFilter TaskFilterName TaskFilterName
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TaskFilter' {TaskFilterName
name :: TaskFilterName
$sel:name:TaskFilter' :: TaskFilter -> TaskFilterName
name} -> TaskFilterName
name) (\s :: TaskFilter
s@TaskFilter' {} TaskFilterName
a -> TaskFilter
s {$sel:name:TaskFilter' :: TaskFilterName
name = TaskFilterName
a} :: TaskFilter)

-- | The values that you want to filter for. For example, you might want to
-- display only tasks for a specific destination location.
taskFilter_values :: Lens.Lens' TaskFilter [Prelude.Text]
taskFilter_values :: ([Text] -> f [Text]) -> TaskFilter -> f TaskFilter
taskFilter_values = (TaskFilter -> [Text])
-> (TaskFilter -> [Text] -> TaskFilter)
-> Lens TaskFilter TaskFilter [Text] [Text]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TaskFilter' {[Text]
values :: [Text]
$sel:values:TaskFilter' :: TaskFilter -> [Text]
values} -> [Text]
values) (\s :: TaskFilter
s@TaskFilter' {} [Text]
a -> TaskFilter
s {$sel:values:TaskFilter' :: [Text]
values = [Text]
a} :: TaskFilter) (([Text] -> f [Text]) -> TaskFilter -> f TaskFilter)
-> (([Text] -> f [Text]) -> [Text] -> f [Text])
-> ([Text] -> f [Text])
-> TaskFilter
-> f TaskFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([Text] -> f [Text]) -> [Text] -> f [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The operator that is used to compare filter values (for example,
-- @Equals@ or @Contains@). For more about API filtering operators, see
-- <https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html API filters for ListTasks and ListLocations>.
taskFilter_operator :: Lens.Lens' TaskFilter Operator
taskFilter_operator :: (Operator -> f Operator) -> TaskFilter -> f TaskFilter
taskFilter_operator = (TaskFilter -> Operator)
-> (TaskFilter -> Operator -> TaskFilter)
-> Lens TaskFilter TaskFilter Operator Operator
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TaskFilter' {Operator
operator :: Operator
$sel:operator:TaskFilter' :: TaskFilter -> Operator
operator} -> Operator
operator) (\s :: TaskFilter
s@TaskFilter' {} Operator
a -> TaskFilter
s {$sel:operator:TaskFilter' :: Operator
operator = Operator
a} :: TaskFilter)

instance Prelude.Hashable TaskFilter

instance Prelude.NFData TaskFilter

instance Core.ToJSON TaskFilter where
  toJSON :: TaskFilter -> Value
toJSON TaskFilter' {[Text]
Operator
TaskFilterName
operator :: Operator
values :: [Text]
name :: TaskFilterName
$sel:operator:TaskFilter' :: TaskFilter -> Operator
$sel:values:TaskFilter' :: TaskFilter -> [Text]
$sel:name:TaskFilter' :: TaskFilter -> TaskFilterName
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Name" Text -> TaskFilterName -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= TaskFilterName
name),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Values" Text -> [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= [Text]
values),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Operator" Text -> Operator -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Operator
operator)
          ]
      )