Class: Aws::Kendra::Types::ColumnConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ColumnConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides information about how Amazon Kendra should use the columns of a database in an index.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #change_detecting_columns ⇒ Array<String>

  One to five columns that indicate when a document in the database has changed.

• #document_data_column_name ⇒ String

  The column that contains the contents of the document.

• #document_id_column_name ⇒ String

  The column that provides the document's identifier.

• #document_title_column_name ⇒ String

  The column that contains the title of the document.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  An array of objects that map database column names to the corresponding fields in an index.

Instance Attribute Details

#change_detecting_columns ⇒ Array<String>

One to five columns that indicate when a document in the database has changed.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1180

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_data_column_name ⇒ String

The column that contains the contents of the document.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1180

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_id_column_name ⇒ String

The column that provides the document's identifier.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1180

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_column_name ⇒ String

The column that contains the title of the document.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1180

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1180

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end