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.Document

Description

Synopsis

Documentation

data Document Source #

The document.

See: newDocument smart constructor.

Constructors

Document'
Fields excerpt :: Maybe DocumentText The excerpt from the document. title :: Maybe DocumentText The title of the document. contentReference :: ContentReference A reference to the content resource.

Instances

Instances details

Eq Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Methods (==) :: Document -> Document -> Bool # (/=) :: Document -> Document -> Bool #
Show Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Methods showsPrec :: Int -> Document -> ShowS # show :: Document -> String # showList :: [Document] -> ShowS #
Generic Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Associated Types type Rep Document :: Type -> Type # Methods from :: Document -> Rep Document x # to :: Rep Document x -> Document #
NFData Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Methods rnf :: Document -> () #
Hashable Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Methods hashWithSalt :: Int -> Document -> Int # hash :: Document -> Int #
FromJSON Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document Methods parseJSON :: Value -> Parser Document # parseJSONList :: Value -> Parser [Document] #
type Rep Document Source #
Instance details Defined in Amazonka.Wisdom.Types.Document type Rep Document = D1 ('MetaData "Document" "Amazonka.Wisdom.Types.Document" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :: S1 ('MetaSel ('Just "contentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContentReference))))

newDocument Source #

Arguments

:: ContentReference	`$sel:contentReference:Document'`
-> Document

Create a value of Document 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:excerpt:Document', document_excerpt - The excerpt from the document.

$sel:title:Document', document_title - The title of the document.

$sel:contentReference:Document', document_contentReference - A reference to the content resource.

document_excerpt :: Lens' Document (Maybe DocumentText) Source #

The excerpt from the document.

document_title :: Lens' Document (Maybe DocumentText) Source #

The title of the document.

document_contentReference :: Lens' Document ContentReference Source #

A reference to the content resource.