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

Description

Documentation

data ConfluenceSpaceToIndexFieldMapping Source #

Maps attributes or field names of Confluence spaces 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: newConfluenceSpaceToIndexFieldMapping smart constructor.

Constructors

ConfluenceSpaceToIndexFieldMapping'

Fields

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

newConfluenceSpaceToIndexFieldMapping :: ConfluenceSpaceToIndexFieldMapping Source #

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

$sel:dateFieldFormat:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_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:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_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.

confluenceSpaceToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe ConfluenceSpaceFieldName) Source #

The name of the field in the data source.

confluenceSpaceToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceSpaceToIndexFieldMapping (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.

confluenceSpaceToIndexFieldMapping_indexFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (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.