You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::ConfluenceAttachmentToIndexFieldMapping

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConfluenceAttachmentToIndexFieldMapping as input to an Aws::Client method, you can use a vanilla Hash:

{
  data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
  date_field_format: "DataSourceDateFieldFormat",
  index_field_name: "IndexFieldName",
}

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_field_name ⇒ String

The name of the field in the data source.

You must first create the index field using the operation.

Possible values:

  • AUTHOR
  • CONTENT_TYPE
  • CREATED_DATE
  • DISPLAY_URL
  • FILE_SIZE
  • ITEM_TYPE
  • PARENT_ID
  • SPACE_KEY
  • SPACE_NAME
  • URL
  • VERSION

Returns:

  • (String) —

    The name of the field in the data source.

#date_field_format ⇒ String

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.

Returns:

  • (String) —

    The format for date fields in the data source.

#index_field_name ⇒ String

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

Returns:

  • (String) —

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