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

Description

Documentation

data ConfluenceBlogToIndexFieldMapping Source #

Maps attributes or field names of Confluence blog to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

See: newConfluenceBlogToIndexFieldMapping smart constructor.

Constructors

ConfluenceBlogToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluenceBlogFieldName
The name of the field in the data source.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

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

newConfluenceBlogToIndexFieldMapping :: ConfluenceBlogToIndexFieldMapping Source #

Create a value of ConfluenceBlogToIndexFieldMapping 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:dataSourceFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

confluenceBlogToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe ConfluenceBlogFieldName) Source #

The name of the field in the data source.

confluenceBlogToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text) Source #

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

confluenceBlogToIndexFieldMapping_indexFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.