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)
Safe Haskell	None

Amazonka.Wisdom.Types.Highlight

Description

Synopsis

data Highlight = Highlight' {
- endOffsetExclusive :: Maybe Int
- beginOffsetInclusive :: Maybe Int
}
newHighlight :: Highlight
highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int)
highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int)

Documentation

data Highlight Source #

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

See: newHighlight smart constructor.

Constructors

Highlight'
Fields endOffsetExclusive :: Maybe Int The offset for the end of the highlight. beginOffsetInclusive :: Maybe Int The offset for the start of the highlight.

Instances

Instances details

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

newHighlight :: Highlight Source #

Create a value of Highlight 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:endOffsetExclusive:Highlight', highlight_endOffsetExclusive - The offset for the end of the highlight.

$sel:beginOffsetInclusive:Highlight', highlight_beginOffsetInclusive - The offset for the start of the highlight.

highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the end of the highlight.

highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the start of the highlight.