Package 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 Details

    • crawlPersonalSpaces

      ConfluenceSpaceConfiguration.Builder crawlPersonalSpaces(Boolean crawlPersonalSpaces)

      TRUE to index personal spaces. You 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 - TRUE to index personal spaces. You 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)

      TRUE to index archived spaces.

      Parameters:
      crawlArchivedSpaces - TRUE to 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)

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

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

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

      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)

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

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

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

      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)

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

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceFieldMappings(List<ConfluenceSpaceToIndexFieldMapping>).

      Parameters:
      spaceFieldMappings - a consumer that will call methods on ConfluenceSpaceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: