{-# 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.Transcribe.Types.NonTalkTimeFilter
-- 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.Transcribe.Types.NonTalkTimeFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.Transcribe.Types.AbsoluteTimeRange
import Amazonka.Transcribe.Types.RelativeTimeRange

-- | An object that enables you to configure your category to be applied to
-- call analytics jobs where either the customer or agent was interrupted.
--
-- /See:/ 'newNonTalkTimeFilter' smart constructor.
data NonTalkTimeFilter = NonTalkTimeFilter'
  { -- | An object that allows percentages to specify the proportion of the call
    -- where there was silence. For example, you can specify the first half of
    -- the call. You can also specify the period of time between halfway
    -- through to three-quarters of the way through the call. Because the
    -- length of conversation can vary between calls, you can apply relative
    -- time ranges across all calls.
    NonTalkTimeFilter -> Maybe RelativeTimeRange
relativeTimeRange :: Prelude.Maybe RelativeTimeRange,
    -- | Set to @TRUE@ to look for a time period when people were talking.
    NonTalkTimeFilter -> Maybe Bool
negate :: Prelude.Maybe Prelude.Bool,
    -- | The duration of the period when neither the customer nor agent was
    -- talking.
    NonTalkTimeFilter -> Maybe Natural
threshold :: Prelude.Maybe Prelude.Natural,
    -- | An object you can use to specify a time range (in milliseconds) for when
    -- no one is talking. For example, you could specify a time period between
    -- the 30,000 millisecond mark and the 45,000 millisecond mark. You could
    -- also specify the time period as the first 15,000 milliseconds or the
    -- last 15,000 milliseconds.
    NonTalkTimeFilter -> Maybe AbsoluteTimeRange
absoluteTimeRange :: Prelude.Maybe AbsoluteTimeRange
  }
  deriving (NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
(NonTalkTimeFilter -> NonTalkTimeFilter -> Bool)
-> (NonTalkTimeFilter -> NonTalkTimeFilter -> Bool)
-> Eq NonTalkTimeFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
$c/= :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
== :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
$c== :: NonTalkTimeFilter -> NonTalkTimeFilter -> Bool
Prelude.Eq, ReadPrec [NonTalkTimeFilter]
ReadPrec NonTalkTimeFilter
Int -> ReadS NonTalkTimeFilter
ReadS [NonTalkTimeFilter]
(Int -> ReadS NonTalkTimeFilter)
-> ReadS [NonTalkTimeFilter]
-> ReadPrec NonTalkTimeFilter
-> ReadPrec [NonTalkTimeFilter]
-> Read NonTalkTimeFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [NonTalkTimeFilter]
$creadListPrec :: ReadPrec [NonTalkTimeFilter]
readPrec :: ReadPrec NonTalkTimeFilter
$creadPrec :: ReadPrec NonTalkTimeFilter
readList :: ReadS [NonTalkTimeFilter]
$creadList :: ReadS [NonTalkTimeFilter]
readsPrec :: Int -> ReadS NonTalkTimeFilter
$creadsPrec :: Int -> ReadS NonTalkTimeFilter
Prelude.Read, Int -> NonTalkTimeFilter -> ShowS
[NonTalkTimeFilter] -> ShowS
NonTalkTimeFilter -> String
(Int -> NonTalkTimeFilter -> ShowS)
-> (NonTalkTimeFilter -> String)
-> ([NonTalkTimeFilter] -> ShowS)
-> Show NonTalkTimeFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [NonTalkTimeFilter] -> ShowS
$cshowList :: [NonTalkTimeFilter] -> ShowS
show :: NonTalkTimeFilter -> String
$cshow :: NonTalkTimeFilter -> String
showsPrec :: Int -> NonTalkTimeFilter -> ShowS
$cshowsPrec :: Int -> NonTalkTimeFilter -> ShowS
Prelude.Show, (forall x. NonTalkTimeFilter -> Rep NonTalkTimeFilter x)
-> (forall x. Rep NonTalkTimeFilter x -> NonTalkTimeFilter)
-> Generic NonTalkTimeFilter
forall x. Rep NonTalkTimeFilter x -> NonTalkTimeFilter
forall x. NonTalkTimeFilter -> Rep NonTalkTimeFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep NonTalkTimeFilter x -> NonTalkTimeFilter
$cfrom :: forall x. NonTalkTimeFilter -> Rep NonTalkTimeFilter x
Prelude.Generic)

-- |
-- Create a value of 'NonTalkTimeFilter' 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:
--
-- 'relativeTimeRange', 'nonTalkTimeFilter_relativeTimeRange' - An object that allows percentages to specify the proportion of the call
-- where there was silence. For example, you can specify the first half of
-- the call. You can also specify the period of time between halfway
-- through to three-quarters of the way through the call. Because the
-- length of conversation can vary between calls, you can apply relative
-- time ranges across all calls.
--
-- 'negate', 'nonTalkTimeFilter_negate' - Set to @TRUE@ to look for a time period when people were talking.
--
-- 'threshold', 'nonTalkTimeFilter_threshold' - The duration of the period when neither the customer nor agent was
-- talking.
--
-- 'absoluteTimeRange', 'nonTalkTimeFilter_absoluteTimeRange' - An object you can use to specify a time range (in milliseconds) for when
-- no one is talking. For example, you could specify a time period between
-- the 30,000 millisecond mark and the 45,000 millisecond mark. You could
-- also specify the time period as the first 15,000 milliseconds or the
-- last 15,000 milliseconds.
newNonTalkTimeFilter ::
  NonTalkTimeFilter
newNonTalkTimeFilter :: NonTalkTimeFilter
newNonTalkTimeFilter =
  NonTalkTimeFilter' :: Maybe RelativeTimeRange
-> Maybe Bool
-> Maybe Natural
-> Maybe AbsoluteTimeRange
-> NonTalkTimeFilter
NonTalkTimeFilter'
    { $sel:relativeTimeRange:NonTalkTimeFilter' :: Maybe RelativeTimeRange
relativeTimeRange =
        Maybe RelativeTimeRange
forall a. Maybe a
Prelude.Nothing,
      $sel:negate:NonTalkTimeFilter' :: Maybe Bool
negate = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:threshold:NonTalkTimeFilter' :: Maybe Natural
threshold = Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:absoluteTimeRange:NonTalkTimeFilter' :: Maybe AbsoluteTimeRange
absoluteTimeRange = Maybe AbsoluteTimeRange
forall a. Maybe a
Prelude.Nothing
    }

-- | An object that allows percentages to specify the proportion of the call
-- where there was silence. For example, you can specify the first half of
-- the call. You can also specify the period of time between halfway
-- through to three-quarters of the way through the call. Because the
-- length of conversation can vary between calls, you can apply relative
-- time ranges across all calls.
nonTalkTimeFilter_relativeTimeRange :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe RelativeTimeRange)
nonTalkTimeFilter_relativeTimeRange :: (Maybe RelativeTimeRange -> f (Maybe RelativeTimeRange))
-> NonTalkTimeFilter -> f NonTalkTimeFilter
nonTalkTimeFilter_relativeTimeRange = (NonTalkTimeFilter -> Maybe RelativeTimeRange)
-> (NonTalkTimeFilter
    -> Maybe RelativeTimeRange -> NonTalkTimeFilter)
-> Lens
     NonTalkTimeFilter
     NonTalkTimeFilter
     (Maybe RelativeTimeRange)
     (Maybe RelativeTimeRange)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe RelativeTimeRange
relativeTimeRange :: Maybe RelativeTimeRange
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
relativeTimeRange} -> Maybe RelativeTimeRange
relativeTimeRange) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe RelativeTimeRange
a -> NonTalkTimeFilter
s {$sel:relativeTimeRange:NonTalkTimeFilter' :: Maybe RelativeTimeRange
relativeTimeRange = Maybe RelativeTimeRange
a} :: NonTalkTimeFilter)

-- | Set to @TRUE@ to look for a time period when people were talking.
nonTalkTimeFilter_negate :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe Prelude.Bool)
nonTalkTimeFilter_negate :: (Maybe Bool -> f (Maybe Bool))
-> NonTalkTimeFilter -> f NonTalkTimeFilter
nonTalkTimeFilter_negate = (NonTalkTimeFilter -> Maybe Bool)
-> (NonTalkTimeFilter -> Maybe Bool -> NonTalkTimeFilter)
-> Lens
     NonTalkTimeFilter NonTalkTimeFilter (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe Bool
negate :: Maybe Bool
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
negate} -> Maybe Bool
negate) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe Bool
a -> NonTalkTimeFilter
s {$sel:negate:NonTalkTimeFilter' :: Maybe Bool
negate = Maybe Bool
a} :: NonTalkTimeFilter)

-- | The duration of the period when neither the customer nor agent was
-- talking.
nonTalkTimeFilter_threshold :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe Prelude.Natural)
nonTalkTimeFilter_threshold :: (Maybe Natural -> f (Maybe Natural))
-> NonTalkTimeFilter -> f NonTalkTimeFilter
nonTalkTimeFilter_threshold = (NonTalkTimeFilter -> Maybe Natural)
-> (NonTalkTimeFilter -> Maybe Natural -> NonTalkTimeFilter)
-> Lens
     NonTalkTimeFilter NonTalkTimeFilter (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe Natural
threshold :: Maybe Natural
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
threshold} -> Maybe Natural
threshold) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe Natural
a -> NonTalkTimeFilter
s {$sel:threshold:NonTalkTimeFilter' :: Maybe Natural
threshold = Maybe Natural
a} :: NonTalkTimeFilter)

-- | An object you can use to specify a time range (in milliseconds) for when
-- no one is talking. For example, you could specify a time period between
-- the 30,000 millisecond mark and the 45,000 millisecond mark. You could
-- also specify the time period as the first 15,000 milliseconds or the
-- last 15,000 milliseconds.
nonTalkTimeFilter_absoluteTimeRange :: Lens.Lens' NonTalkTimeFilter (Prelude.Maybe AbsoluteTimeRange)
nonTalkTimeFilter_absoluteTimeRange :: (Maybe AbsoluteTimeRange -> f (Maybe AbsoluteTimeRange))
-> NonTalkTimeFilter -> f NonTalkTimeFilter
nonTalkTimeFilter_absoluteTimeRange = (NonTalkTimeFilter -> Maybe AbsoluteTimeRange)
-> (NonTalkTimeFilter
    -> Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
-> Lens
     NonTalkTimeFilter
     NonTalkTimeFilter
     (Maybe AbsoluteTimeRange)
     (Maybe AbsoluteTimeRange)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NonTalkTimeFilter' {Maybe AbsoluteTimeRange
absoluteTimeRange :: Maybe AbsoluteTimeRange
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
absoluteTimeRange} -> Maybe AbsoluteTimeRange
absoluteTimeRange) (\s :: NonTalkTimeFilter
s@NonTalkTimeFilter' {} Maybe AbsoluteTimeRange
a -> NonTalkTimeFilter
s {$sel:absoluteTimeRange:NonTalkTimeFilter' :: Maybe AbsoluteTimeRange
absoluteTimeRange = Maybe AbsoluteTimeRange
a} :: NonTalkTimeFilter)

instance Core.FromJSON NonTalkTimeFilter where
  parseJSON :: Value -> Parser NonTalkTimeFilter
parseJSON =
    String
-> (Object -> Parser NonTalkTimeFilter)
-> Value
-> Parser NonTalkTimeFilter
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"NonTalkTimeFilter"
      ( \Object
x ->
          Maybe RelativeTimeRange
-> Maybe Bool
-> Maybe Natural
-> Maybe AbsoluteTimeRange
-> NonTalkTimeFilter
NonTalkTimeFilter'
            (Maybe RelativeTimeRange
 -> Maybe Bool
 -> Maybe Natural
 -> Maybe AbsoluteTimeRange
 -> NonTalkTimeFilter)
-> Parser (Maybe RelativeTimeRange)
-> Parser
     (Maybe Bool
      -> Maybe Natural -> Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe RelativeTimeRange)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"RelativeTimeRange")
            Parser
  (Maybe Bool
   -> Maybe Natural -> Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
-> Parser (Maybe Bool)
-> Parser
     (Maybe Natural -> Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Bool)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Negate")
            Parser
  (Maybe Natural -> Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
-> Parser (Maybe Natural)
-> Parser (Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Threshold")
            Parser (Maybe AbsoluteTimeRange -> NonTalkTimeFilter)
-> Parser (Maybe AbsoluteTimeRange) -> Parser NonTalkTimeFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe AbsoluteTimeRange)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"AbsoluteTimeRange")
      )

instance Prelude.Hashable NonTalkTimeFilter

instance Prelude.NFData NonTalkTimeFilter

instance Core.ToJSON NonTalkTimeFilter where
  toJSON :: NonTalkTimeFilter -> Value
toJSON NonTalkTimeFilter' {Maybe Bool
Maybe Natural
Maybe AbsoluteTimeRange
Maybe RelativeTimeRange
absoluteTimeRange :: Maybe AbsoluteTimeRange
threshold :: Maybe Natural
negate :: Maybe Bool
relativeTimeRange :: Maybe RelativeTimeRange
$sel:absoluteTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe AbsoluteTimeRange
$sel:threshold:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Natural
$sel:negate:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe Bool
$sel:relativeTimeRange:NonTalkTimeFilter' :: NonTalkTimeFilter -> Maybe RelativeTimeRange
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"RelativeTimeRange" Text -> RelativeTimeRange -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (RelativeTimeRange -> Pair)
-> Maybe RelativeTimeRange -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe RelativeTimeRange
relativeTimeRange,
            (Text
"Negate" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Bool -> Pair) -> Maybe Bool -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
negate,
            (Text
"Threshold" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
threshold,
            (Text
"AbsoluteTimeRange" Text -> AbsoluteTimeRange -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (AbsoluteTimeRange -> Pair)
-> Maybe AbsoluteTimeRange -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe AbsoluteTimeRange
absoluteTimeRange
          ]
      )