Amazonka.Wisdom.Types.Highlight

Documentation

data Highlight

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

See: newHighlight smart constructor.

Constructors

Highlight'

Fields

• beginOffsetInclusive :: Maybe Int

  The offset for the start of the highlight.

• endOffsetExclusive :: Maybe Int

  The offset for the end of the highlight.

Instances

FromJSON Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

parseJSON :: Value -> Parser Highlight

parseJSONList :: Value -> Parser [Highlight]

Generic Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Associated Types

type Rep Highlight :: Type -> Type

Methods

from :: Highlight -> Rep Highlight x

to :: Rep Highlight x -> Highlight

Read Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

readsPrec :: Int -> ReadS Highlight

readList :: ReadS [Highlight]

readPrec :: ReadPrec Highlight

readListPrec :: ReadPrec [Highlight]

Show Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

showsPrec :: Int -> Highlight -> ShowS

show :: Highlight -> String

showList :: [Highlight] -> ShowS

NFData Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

rnf :: Highlight -> ()

Eq Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

(==) :: Highlight -> Highlight -> Bool

(/=) :: Highlight -> Highlight -> Bool

Hashable Highlight

Defined in Amazonka.Wisdom.Types.Highlight

Methods

hashWithSalt :: Int -> Highlight -> Int

hash :: Highlight -> Int

type Rep Highlight

Defined in Amazonka.Wisdom.Types.Highlight

type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Wisdom.Types.Highlight" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffsetInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffsetExclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newHighlight :: Highlight

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:beginOffsetInclusive:Highlight', highlight_beginOffsetInclusive - The offset for the start of the highlight.

$sel:endOffsetExclusive:Highlight', highlight_endOffsetExclusive - The offset for the end of the highlight.

highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int)

The offset for the start of the highlight.

highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int)

The offset for the end of the highlight.