software.amazon.awssdk.services.kendra.model

Interface ConfluenceSpaceConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ConfluenceSpaceConfiguration

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

Method Summary

Modifier and Type	Method and Description
ConfluenceSpaceConfiguration.Builder	crawlArchivedSpaces(Boolean crawlArchivedSpaces) Specifies whether Amazon Kendra should index archived spaces.
ConfluenceSpaceConfiguration.Builder	crawlPersonalSpaces(Boolean crawlPersonalSpaces) Specifies whether Amazon Kendra should index personal spaces.
ConfluenceSpaceConfiguration.Builder	excludeSpaces(Collection<String> excludeSpaces) A list of space keys of Confluence spaces.
ConfluenceSpaceConfiguration.Builder	excludeSpaces(String... excludeSpaces) A list of space keys of Confluence spaces.
ConfluenceSpaceConfiguration.Builder	includeSpaces(Collection<String> includeSpaces) A list of space keys for Confluence spaces.
ConfluenceSpaceConfiguration.Builder	includeSpaces(String... includeSpaces) A list of space keys for Confluence spaces.
ConfluenceSpaceConfiguration.Builder	spaceFieldMappings(Collection<ConfluenceSpaceToIndexFieldMapping> spaceFieldMappings) Defines how space metadata fields should be mapped to index fields.
ConfluenceSpaceConfiguration.Builder	spaceFieldMappings(ConfluenceSpaceToIndexFieldMapping... spaceFieldMappings) Defines how space metadata fields should be mapped to index fields.
ConfluenceSpaceConfiguration.Builder	spaceFieldMappings(Consumer<ConfluenceSpaceToIndexFieldMapping.Builder>... spaceFieldMappings) Defines how space metadata fields should be mapped to index fields.

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

crawlPersonalSpaces

ConfluenceSpaceConfiguration.Builder crawlPersonalSpaces(Boolean crawlPersonalSpaces)

Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

Parameters:

crawlPersonalSpaces - Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

Returns:

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

crawlArchivedSpaces

ConfluenceSpaceConfiguration.Builder crawlArchivedSpaces(Boolean crawlArchivedSpaces)

Specifies whether Amazon Kendra should index archived spaces.

Parameters:

crawlArchivedSpaces - Specifies whether Amazon Kendra should index archived spaces.

Returns:

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

includeSpaces

ConfluenceSpaceConfiguration.Builder includeSpaces(Collection<String> includeSpaces)

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Parameters:

includeSpaces - A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Returns:

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

includeSpaces

ConfluenceSpaceConfiguration.Builder includeSpaces(String... includeSpaces)

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Parameters:

includeSpaces - A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Returns:

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

excludeSpaces

ConfluenceSpaceConfiguration.Builder excludeSpaces(Collection<String> excludeSpaces)

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Parameters:

excludeSpaces - A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Returns:

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

excludeSpaces

ConfluenceSpaceConfiguration.Builder excludeSpaces(String... excludeSpaces)

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Parameters:

excludeSpaces - A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Returns:

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

spaceFieldMappings

ConfluenceSpaceConfiguration.Builder spaceFieldMappings(Collection<ConfluenceSpaceToIndexFieldMapping> spaceFieldMappings)

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Parameters:

spaceFieldMappings - Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Returns:

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

spaceFieldMappings

ConfluenceSpaceConfiguration.Builder spaceFieldMappings(ConfluenceSpaceToIndexFieldMapping... spaceFieldMappings)

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Parameters:

spaceFieldMappings - Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Returns:

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

spaceFieldMappings

ConfluenceSpaceConfiguration.Builder spaceFieldMappings(Consumer<ConfluenceSpaceToIndexFieldMapping.Builder>... spaceFieldMappings)

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #spaceFieldMappings(List).

Parameters:

spaceFieldMappings - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#spaceFieldMappings(List)