Class: Aws::Kendra::Types::SalesforceCustomKnowledgeArticleTypeConfiguration

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

Overview

Provides the configuration information for indexing Salesforce custom articles.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_data_field_name ⇒ String

The name of the field in the custom knowledge article that contains the document data to index.

Returns:

  • (String) 


8973
8974
8975
8976
8977
8978
8979
8980
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8973

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_name ⇒ String

The name of the field in the custom knowledge article that contains the document title.

Returns:

  • (String) 


8973
8974
8975
8976
8977
8978
8979
8980
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8973

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:



8973
8974
8975
8976
8977
8978
8979
8980
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8973

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the configuration.

Returns:

  • (String) 


8973
8974
8975
8976
8977
8978
8979
8980
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8973

class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end