Interface WorkDocsConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkDocsConfiguration.Builder,
,WorkDocsConfiguration> SdkBuilder<WorkDocsConfiguration.Builder,
,WorkDocsConfiguration> SdkPojo
- Enclosing class:
WorkDocsConfiguration
-
Method Summary
Modifier and TypeMethodDescriptioncrawlComments
(Boolean crawlComments) TRUE
to include comments on documents in your index.exclusionPatterns
(String... exclusionPatterns) A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.exclusionPatterns
(Collection<String> exclusionPatterns) A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.fieldMappings
(Collection<DataSourceToIndexFieldMapping> fieldMappings) A list ofDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.fieldMappings
(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings) A list ofDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.fieldMappings
(DataSourceToIndexFieldMapping... fieldMappings) A list ofDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.inclusionPatterns
(String... inclusionPatterns) A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.inclusionPatterns
(Collection<String> inclusionPatterns) A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.organizationId
(String organizationId) The identifier of the directory corresponding to your Amazon WorkDocs site repository.useChangeLog
(Boolean useChangeLog) TRUE
to use the Amazon WorkDocs change log to determine which documents require updating in the index.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
organizationId
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
- Parameters:
organizationId
- The identifier of the directory corresponding to your Amazon WorkDocs site repository.You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
useChangeLog
TRUE
to use the Amazon 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 Amazon WorkDocs.- Parameters:
useChangeLog
-TRUE
to use the Amazon 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 Amazon WorkDocs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inclusionPatterns
A list of regular expression patterns to include certain files in your Amazon 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.
- Parameters:
inclusionPatterns
- A list of regular expression patterns to include certain files in your Amazon 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:
- Returns a reference to this object so that method calls can be chained together.
-
inclusionPatterns
A list of regular expression patterns to include certain files in your Amazon 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.
- Parameters:
inclusionPatterns
- A list of regular expression patterns to include certain files in your Amazon 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:
- Returns a reference to this object so that method calls can be chained together.
-
exclusionPatterns
A list of regular expression patterns to exclude certain files in your Amazon 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.
- Parameters:
exclusionPatterns
- A list of regular expression patterns to exclude certain files in your Amazon 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:
- Returns a reference to this object so that method calls can be chained together.
-
exclusionPatterns
A list of regular expression patterns to exclude certain files in your Amazon 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.
- Parameters:
exclusionPatterns
- A list of regular expression patterns to exclude certain files in your Amazon 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:
- Returns a reference to this object so that method calls can be chained together.
-
fieldMappings
WorkDocsConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) A list of
DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.- Parameters:
fieldMappings
- A list ofDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldMappings
A list of
DataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.- Parameters:
fieldMappings
- A list ofDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldMappings
WorkDocsConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings) A list of
This is a convenience method that creates an instance of theDataSourceToIndexFieldMapping
objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.DataSourceToIndexFieldMapping.Builder
avoiding the need to create one manually viaDataSourceToIndexFieldMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofieldMappings(List<DataSourceToIndexFieldMapping>)
.- Parameters:
fieldMappings
- a consumer that will call methods onDataSourceToIndexFieldMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-