Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.SuggestionHighlight

Description

Documentation

data SuggestionHighlight Source #

The text highlights for a single query suggestion.

See: newSuggestionHighlight smart constructor.

Constructors

SuggestionHighlight'
Fields beginOffset :: Maybe Int The zero-based location in the response string where the highlight starts. endOffset :: Maybe Int The zero-based location in the response string where the highlight ends.

Instances

Instances details

FromJSON SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods parseJSON :: Value -> Parser SuggestionHighlight # parseJSONList :: Value -> Parser [SuggestionHighlight] #
Generic SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Associated Types type Rep SuggestionHighlight :: Type -> Type # Methods from :: SuggestionHighlight -> Rep SuggestionHighlight x # to :: Rep SuggestionHighlight x -> SuggestionHighlight #
Read SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods readsPrec :: Int -> ReadS SuggestionHighlight # readList :: ReadS [SuggestionHighlight] # readPrec :: ReadPrec SuggestionHighlight # readListPrec :: ReadPrec [SuggestionHighlight] #
Show SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods showsPrec :: Int -> SuggestionHighlight -> ShowS # show :: SuggestionHighlight -> String # showList :: [SuggestionHighlight] -> ShowS #
NFData SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods rnf :: SuggestionHighlight -> () #
Eq SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods (==) :: SuggestionHighlight -> SuggestionHighlight -> Bool # (/=) :: SuggestionHighlight -> SuggestionHighlight -> Bool #
Hashable SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods hashWithSalt :: Int -> SuggestionHighlight -> Int # hash :: SuggestionHighlight -> Int #
type Rep SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight type Rep SuggestionHighlight = D1 ('MetaData "SuggestionHighlight" "Amazonka.Kendra.Types.SuggestionHighlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionHighlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newSuggestionHighlight :: SuggestionHighlight Source #

Create a value of SuggestionHighlight with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:SuggestionHighlight', suggestionHighlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:SuggestionHighlight', suggestionHighlight_endOffset - The zero-based location in the response string where the highlight ends.

suggestionHighlight_beginOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

The zero-based location in the response string where the highlight starts.

suggestionHighlight_endOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

The zero-based location in the response string where the highlight ends.