{-# 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.Kendra.Types.SuggestionHighlight
-- 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.Kendra.Types.SuggestionHighlight 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

-- | The text highlights for a single query suggestion.
--
-- /See:/ 'newSuggestionHighlight' smart constructor.
data SuggestionHighlight = SuggestionHighlight'
  { -- | The zero-based location in the response string where the highlight
    -- starts.
    SuggestionHighlight -> Maybe Int
beginOffset :: Prelude.Maybe Prelude.Int,
    -- | The zero-based location in the response string where the highlight ends.
    SuggestionHighlight -> Maybe Int
endOffset :: Prelude.Maybe Prelude.Int
  }
  deriving (SuggestionHighlight -> SuggestionHighlight -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SuggestionHighlight -> SuggestionHighlight -> Bool
$c/= :: SuggestionHighlight -> SuggestionHighlight -> Bool
== :: SuggestionHighlight -> SuggestionHighlight -> Bool
$c== :: SuggestionHighlight -> SuggestionHighlight -> Bool
Prelude.Eq, ReadPrec [SuggestionHighlight]
ReadPrec SuggestionHighlight
Int -> ReadS SuggestionHighlight
ReadS [SuggestionHighlight]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SuggestionHighlight]
$creadListPrec :: ReadPrec [SuggestionHighlight]
readPrec :: ReadPrec SuggestionHighlight
$creadPrec :: ReadPrec SuggestionHighlight
readList :: ReadS [SuggestionHighlight]
$creadList :: ReadS [SuggestionHighlight]
readsPrec :: Int -> ReadS SuggestionHighlight
$creadsPrec :: Int -> ReadS SuggestionHighlight
Prelude.Read, Int -> SuggestionHighlight -> ShowS
[SuggestionHighlight] -> ShowS
SuggestionHighlight -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SuggestionHighlight] -> ShowS
$cshowList :: [SuggestionHighlight] -> ShowS
show :: SuggestionHighlight -> String
$cshow :: SuggestionHighlight -> String
showsPrec :: Int -> SuggestionHighlight -> ShowS
$cshowsPrec :: Int -> SuggestionHighlight -> ShowS
Prelude.Show, forall x. Rep SuggestionHighlight x -> SuggestionHighlight
forall x. SuggestionHighlight -> Rep SuggestionHighlight x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SuggestionHighlight x -> SuggestionHighlight
$cfrom :: forall x. SuggestionHighlight -> Rep SuggestionHighlight x
Prelude.Generic)

-- |
-- Create a value of 'SuggestionHighlight' 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:
--
-- 'beginOffset', 'suggestionHighlight_beginOffset' - The zero-based location in the response string where the highlight
-- starts.
--
-- 'endOffset', 'suggestionHighlight_endOffset' - The zero-based location in the response string where the highlight ends.
newSuggestionHighlight ::
  SuggestionHighlight
newSuggestionHighlight :: SuggestionHighlight
newSuggestionHighlight =
  SuggestionHighlight'
    { $sel:beginOffset:SuggestionHighlight' :: Maybe Int
beginOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:endOffset:SuggestionHighlight' :: Maybe Int
endOffset = forall a. Maybe a
Prelude.Nothing
    }

-- | The zero-based location in the response string where the highlight
-- starts.
suggestionHighlight_beginOffset :: Lens.Lens' SuggestionHighlight (Prelude.Maybe Prelude.Int)
suggestionHighlight_beginOffset :: Lens' SuggestionHighlight (Maybe Int)
suggestionHighlight_beginOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuggestionHighlight' {Maybe Int
beginOffset :: Maybe Int
$sel:beginOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
beginOffset} -> Maybe Int
beginOffset) (\s :: SuggestionHighlight
s@SuggestionHighlight' {} Maybe Int
a -> SuggestionHighlight
s {$sel:beginOffset:SuggestionHighlight' :: Maybe Int
beginOffset = Maybe Int
a} :: SuggestionHighlight)

-- | The zero-based location in the response string where the highlight ends.
suggestionHighlight_endOffset :: Lens.Lens' SuggestionHighlight (Prelude.Maybe Prelude.Int)
suggestionHighlight_endOffset :: Lens' SuggestionHighlight (Maybe Int)
suggestionHighlight_endOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuggestionHighlight' {Maybe Int
endOffset :: Maybe Int
$sel:endOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
endOffset} -> Maybe Int
endOffset) (\s :: SuggestionHighlight
s@SuggestionHighlight' {} Maybe Int
a -> SuggestionHighlight
s {$sel:endOffset:SuggestionHighlight' :: Maybe Int
endOffset = Maybe Int
a} :: SuggestionHighlight)

instance Data.FromJSON SuggestionHighlight where
  parseJSON :: Value -> Parser SuggestionHighlight
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SuggestionHighlight"
      ( \Object
x ->
          Maybe Int -> Maybe Int -> SuggestionHighlight
SuggestionHighlight'
            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
"BeginOffset")
            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
"EndOffset")
      )

instance Prelude.Hashable SuggestionHighlight where
  hashWithSalt :: Int -> SuggestionHighlight -> Int
hashWithSalt Int
_salt SuggestionHighlight' {Maybe Int
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:endOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
$sel:beginOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
beginOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
endOffset

instance Prelude.NFData SuggestionHighlight where
  rnf :: SuggestionHighlight -> ()
rnf SuggestionHighlight' {Maybe Int
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:endOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
$sel:beginOffset:SuggestionHighlight' :: SuggestionHighlight -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
beginOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
endOffset