You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SalesforceStandardObjectConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
  document_data_field_name: "DataSourceFieldName", # required
  document_title_field_name: "DataSourceFieldName",
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
}

Specifies confguration information for indexing a single standard object.

See Also:

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

    The name of the field in the standard object table that contains the document contents.

#document_title_field_name ⇒ String

The name of the field in the standard object table that contains the document titleB.

Returns:

  • (String) —

    The name of the field in the standard object table that contains the document titleB.

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

Returns:

#name ⇒ String

The name of the standard object.

Possible values:

  • ACCOUNT
  • CAMPAIGN
  • CASE
  • CONTACT
  • CONTRACT
  • DOCUMENT
  • GROUP
  • IDEA
  • LEAD
  • OPPORTUNITY
  • PARTNER
  • PRICEBOOK
  • PRODUCT
  • PROFILE
  • SOLUTION
  • TASK
  • USER

Returns:

  • (String) —

    The name of the standard object.