Package software.amazon.awscdk.services.kendra

Class CfnDataSource.WorkDocsConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnDataSource.WorkDocsConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.WorkDocsConfigurationProperty>

Enclosing interface:

CfnDataSource.WorkDocsConfigurationProperty

@Stability(Stable)
public static final class CfnDataSource.WorkDocsConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.WorkDocsConfigurationProperty>

A builder for CfnDataSource.WorkDocsConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.WorkDocsConfigurationProperty	build()	Builds the configured instance.
CfnDataSource.WorkDocsConfigurationProperty.Builder	crawlComments(Boolean crawlComments)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getCrawlComments()
CfnDataSource.WorkDocsConfigurationProperty.Builder	crawlComments(IResolvable crawlComments)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getCrawlComments()
CfnDataSource.WorkDocsConfigurationProperty.Builder	exclusionPatterns(List<String> exclusionPatterns)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getExclusionPatterns()
CfnDataSource.WorkDocsConfigurationProperty.Builder	fieldMappings(List<? extends Object> fieldMappings)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getFieldMappings()
CfnDataSource.WorkDocsConfigurationProperty.Builder	fieldMappings(IResolvable fieldMappings)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getFieldMappings()
CfnDataSource.WorkDocsConfigurationProperty.Builder	inclusionPatterns(List<String> inclusionPatterns)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getInclusionPatterns()
CfnDataSource.WorkDocsConfigurationProperty.Builder	organizationId(String organizationId)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getOrganizationId()
CfnDataSource.WorkDocsConfigurationProperty.Builder	useChangeLog(Boolean useChangeLog)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getUseChangeLog()
CfnDataSource.WorkDocsConfigurationProperty.Builder	useChangeLog(IResolvable useChangeLog)	Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getUseChangeLog()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

organizationId

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder organizationId(String organizationId)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getOrganizationId()

Parameters:

organizationId - The identifier of the directory corresponding to your WorkDocs site repository. This parameter is required. You can find the organization ID in the Directory Service by going to Active Directory , then Directories . Your WorkDocs site directory has an ID, which is the organization ID. You can also set up a new WorkDocs directory in the Directory Service console and enable a WorkDocs site for the directory in the WorkDocs console.

Returns:

this

crawlComments

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder crawlComments(Boolean crawlComments)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getCrawlComments()

Parameters:

crawlComments - TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

Returns:

this

crawlComments

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder crawlComments(IResolvable crawlComments)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getCrawlComments()

Parameters:

crawlComments - TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

Returns:

this

exclusionPatterns

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder exclusionPatterns(List<String> exclusionPatterns)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getExclusionPatterns()

Parameters:

exclusionPatterns - A list of regular expression patterns to exclude certain files in your WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

Returns:

this

fieldMappings

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder fieldMappings(IResolvable fieldMappings)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getFieldMappings()

Parameters:

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

Returns:

this

fieldMappings

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder fieldMappings(List<? extends Object> fieldMappings)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getFieldMappings()

Parameters:

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

Returns:

this

inclusionPatterns

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder inclusionPatterns(List<String> inclusionPatterns)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getInclusionPatterns()

Parameters:

inclusionPatterns - A list of regular expression patterns to include certain files in your WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

Returns:

this

useChangeLog

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder useChangeLog(Boolean useChangeLog)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getUseChangeLog()

Parameters:

useChangeLog - TRUE to use the WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in WorkDocs.

Returns:

this

useChangeLog

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty.Builder useChangeLog(IResolvable useChangeLog)

Sets the value of CfnDataSource.WorkDocsConfigurationProperty.getUseChangeLog()

Parameters:

useChangeLog - TRUE to use the WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in WorkDocs.

Returns:

this

build

@Stability(Stable)
public CfnDataSource.WorkDocsConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.WorkDocsConfigurationProperty>

Returns:

a new instance of CfnDataSource.WorkDocsConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided