/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kendra.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Configuration information for indexing Confluence spaces. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ConfluenceSpaceConfiguration implements Serializable, Cloneable, StructuredPojo { /** *
* 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.
*
* TRUE
to index archived spaces.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
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.
*/
public void setCrawlPersonalSpaces(Boolean crawlPersonalSpaces) {
this.crawlPersonalSpaces = 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.
*
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.
*/
public Boolean getCrawlPersonalSpaces() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withCrawlPersonalSpaces(Boolean crawlPersonalSpaces) {
setCrawlPersonalSpaces(crawlPersonalSpaces);
return this;
}
/**
*
* 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.
*
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.
*/
public Boolean isCrawlPersonalSpaces() {
return this.crawlPersonalSpaces;
}
/**
*
* TRUE
to index archived spaces.
*
TRUE
to index archived spaces.
*/
public void setCrawlArchivedSpaces(Boolean crawlArchivedSpaces) {
this.crawlArchivedSpaces = crawlArchivedSpaces;
}
/**
*
* TRUE
to index archived spaces.
*
TRUE
to index archived spaces.
*/
public Boolean getCrawlArchivedSpaces() {
return this.crawlArchivedSpaces;
}
/**
*
* TRUE
to index archived spaces.
*
TRUE
to index archived spaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withCrawlArchivedSpaces(Boolean crawlArchivedSpaces) {
setCrawlArchivedSpaces(crawlArchivedSpaces);
return this;
}
/**
*
* TRUE
to index archived spaces.
*
TRUE
to index archived spaces.
*/
public Boolean isCrawlArchivedSpaces() {
return this.crawlArchivedSpaces;
}
/**
*
* 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.
*
IncludeSpaces
and the ExcludeSpaces
list, the space is excluded.
*/
public java.util.List
* 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.
*
IncludeSpaces
and the ExcludeSpaces
list, the space is excluded.
*/
public void setIncludeSpaces(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setIncludeSpaces(java.util.Collection)} or {@link #withIncludeSpaces(java.util.Collection)} if you want * to override the existing values. *
* * @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withIncludeSpaces(String... includeSpaces) {
if (this.includeSpaces == null) {
setIncludeSpaces(new java.util.ArrayList
* 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.
*
IncludeSpaces
and the ExcludeSpaces
list, the space is excluded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withIncludeSpaces(java.util.Collection
* 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.
*
ExcludeSpaces
and the
* IncludeSpaces
list, the space is excluded.
*/
public java.util.List
* 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.
*
ExcludeSpaces
and the
* IncludeSpaces
list, the space is excluded.
*/
public void setExcludeSpaces(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setExcludeSpaces(java.util.Collection)} or {@link #withExcludeSpaces(java.util.Collection)} if you want * to override the existing values. *
* * @param 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 theExcludeSpaces
and the
* IncludeSpaces
list, the space is excluded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withExcludeSpaces(String... excludeSpaces) {
if (this.excludeSpaces == null) {
setExcludeSpaces(new java.util.ArrayList
* 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.
*
ExcludeSpaces
and the
* IncludeSpaces
list, the space is excluded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withExcludeSpaces(java.util.Collection
* 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.
*
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
* Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields,
* use the
* If you specify the SpaceFieldMappings
parameter, you must specify at least one field
* mapping.
*/
public java.util.ListUpdateIndex
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.
* SpaceFieldMappings
parameter, you must specify at least one field mapping.
* 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
* Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields,
* use the
* If you specify the
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSpaceFieldMappings(java.util.Collection)} or {@link #withSpaceFieldMappings(java.util.Collection)} if
* you want to override the existing values.
* SpaceFieldMappings
parameter, you must specify at least one field mapping.
*/
public void setSpaceFieldMappings(java.util.CollectionUpdateIndex
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.
* SpaceFieldMappings
parameter, you must specify at least one field mapping.
* 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
* Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields,
* use the
* If you specify the SpaceFieldMappings
parameter, you must specify at least one field mapping.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withSpaceFieldMappings(ConfluenceSpaceToIndexFieldMapping... spaceFieldMappings) {
if (this.spaceFieldMappings == null) {
setSpaceFieldMappings(new java.util.ArrayListUpdateIndex
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.
* SpaceFieldMappings
parameter, you must specify at least one field mapping.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfluenceSpaceConfiguration withSpaceFieldMappings(java.util.Collection