Class: Aws::Kendra::Types::SalesforceStandardObjectConfiguration

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

Overview

Provides the configuration information for indexing a single standard object.

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 standard object table that contains the document contents.

Returns:

  • (String) 


9099
9100
9101
9102
9103
9104
9105
9106
 
# File 'lib/aws-sdk-kendra/types.rb', line 9099

class SalesforceStandardObjectConfiguration < 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 standard object table that contains the document title.

Returns:

  • (String) 


9099
9100
9101
9102
9103
9104
9105
9106
 
# File 'lib/aws-sdk-kendra/types.rb', line 9099

class SalesforceStandardObjectConfiguration < 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 standard object 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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



9099
9100
9101
9102
9103
9104
9105
9106
 
# File 'lib/aws-sdk-kendra/types.rb', line 9099

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

#name ⇒ String

The name of the standard object.

Returns:

  • (String) 


9099
9100
9101
9102
9103
9104
9105
9106
 
# File 'lib/aws-sdk-kendra/types.rb', line 9099

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