Class: Aws::Kendra::Types::ConfluencePageToIndexFieldMapping

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ConfluencePageToIndexFieldMapping data as a hash:

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

>Maps attributes or field names of Confluence pages 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_field_nameString

The name of the field in the data source.

Returns:

  • (String)


2095
2096
2097
2098
2099
2100
2101
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2095

class ConfluencePageToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#date_field_formatString

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)


2095
2096
2097
2098
2099
2100
2101
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2095

class ConfluencePageToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#index_field_nameString

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)


2095
2096
2097
2098
2099
2100
2101
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2095

class ConfluencePageToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end