software.amazon.awssdk.services.kendra.model

Interface ServiceNowServiceCatalogConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ServiceNowServiceCatalogConfiguration.Builder,ServiceNowServiceCatalogConfiguration>, SdkBuilder<ServiceNowServiceCatalogConfiguration.Builder,ServiceNowServiceCatalogConfiguration>, SdkPojo

Enclosing class:

ServiceNowServiceCatalogConfiguration

public static interface ServiceNowServiceCatalogConfiguration.Builder
extends SdkPojo, CopyableBuilder<ServiceNowServiceCatalogConfiguration.Builder,ServiceNowServiceCatalogConfiguration>

Method Summary

Modifier and Type	Method and Description
ServiceNowServiceCatalogConfiguration.Builder	crawlAttachments(Boolean crawlAttachments) TRUE to index attachments to service catalog items.
ServiceNowServiceCatalogConfiguration.Builder	documentDataFieldName(String documentDataFieldName) The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
ServiceNowServiceCatalogConfiguration.Builder	documentTitleFieldName(String documentTitleFieldName) The name of the ServiceNow field that is mapped to the index document title field.
ServiceNowServiceCatalogConfiguration.Builder	excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns) A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.
ServiceNowServiceCatalogConfiguration.Builder	excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns) A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.
ServiceNowServiceCatalogConfiguration.Builder	fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) Maps attributes or field names of catalogs to Amazon Kendra index field names.
ServiceNowServiceCatalogConfiguration.Builder	fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings) Maps attributes or field names of catalogs to Amazon Kendra index field names.
ServiceNowServiceCatalogConfiguration.Builder	fieldMappings(DataSourceToIndexFieldMapping... fieldMappings) Maps attributes or field names of catalogs to Amazon Kendra index field names.
ServiceNowServiceCatalogConfiguration.Builder	includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns) A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.
ServiceNowServiceCatalogConfiguration.Builder	includeAttachmentFilePatterns(String... includeAttachmentFilePatterns) A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

crawlAttachments

ServiceNowServiceCatalogConfiguration.Builder crawlAttachments(Boolean crawlAttachments)

TRUE to index attachments to service catalog items.

Parameters:

crawlAttachments - TRUE to index attachments to service catalog items.

Returns:

Returns a reference to this object so that method calls can be chained together.

includeAttachmentFilePatterns

ServiceNowServiceCatalogConfiguration.Builder includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Parameters:

includeAttachmentFilePatterns - A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Returns:

Returns a reference to this object so that method calls can be chained together.

includeAttachmentFilePatterns

ServiceNowServiceCatalogConfiguration.Builder includeAttachmentFilePatterns(String... includeAttachmentFilePatterns)

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Parameters:

includeAttachmentFilePatterns - A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeAttachmentFilePatterns

ServiceNowServiceCatalogConfiguration.Builder excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Parameters:

excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeAttachmentFilePatterns

ServiceNowServiceCatalogConfiguration.Builder excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Parameters:

excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentDataFieldName

ServiceNowServiceCatalogConfiguration.Builder documentDataFieldName(String documentDataFieldName)

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Parameters:

documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentTitleFieldName

ServiceNowServiceCatalogConfiguration.Builder documentTitleFieldName(String documentTitleFieldName)

The name of the ServiceNow field that is mapped to the index document title field.

Parameters:

documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

Returns:

Returns a reference to this object so that method calls can be chained together.

fieldMappings

ServiceNowServiceCatalogConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fieldMappings

ServiceNowServiceCatalogConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fieldMappings

ServiceNowServiceCatalogConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)

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

This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #fieldMappings(List).

Parameters:

fieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#fieldMappings(java.util.Collection)