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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_field_name ⇒ String

The name of the field in the data source.

Returns:

  • (String) 

1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-kendra/types.rb', line 1190

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

#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) 

1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-kendra/types.rb', line 1190

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

#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) 

1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/aws-sdk-kendra/types.rb', line 1190

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