ConfluenceSpaceConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.ConfluenceSpaceConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfluenceSpaceConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies the configuration for indexing Confluence spaces.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConfluenceSpaceConfiguration()

Constructors
Constructor and Description
`ConfluenceSpaceConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfluenceSpaceConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCrawlArchivedSpaces()` Specifies whether Amazon Kendra should index archived spaces.
`Boolean`	`getCrawlPersonalSpaces()` Specifies whether Amazon Kendra should index personal spaces.
`List<String>`	`getExcludeSpaces()` A list of space keys of Confluence spaces.
`List<String>`	`getIncludeSpaces()` A list of space keys for Confluence spaces.
`List<ConfluenceSpaceToIndexFieldMapping>`	`getSpaceFieldMappings()` Defines how space metadata fields should be mapped to index fields.
`int`	`hashCode()`
`Boolean`	`isCrawlArchivedSpaces()` Specifies whether Amazon Kendra should index archived spaces.
`Boolean`	`isCrawlPersonalSpaces()` Specifies whether Amazon Kendra should index personal spaces.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCrawlArchivedSpaces(Boolean crawlArchivedSpaces)` Specifies whether Amazon Kendra should index archived spaces.
`void`	`setCrawlPersonalSpaces(Boolean crawlPersonalSpaces)` Specifies whether Amazon Kendra should index personal spaces.
`void`	`setExcludeSpaces(Collection<String> excludeSpaces)` A list of space keys of Confluence spaces.
`void`	`setIncludeSpaces(Collection<String> includeSpaces)` A list of space keys for Confluence spaces.
`void`	`setSpaceFieldMappings(Collection<ConfluenceSpaceToIndexFieldMapping> spaceFieldMappings)` Defines how space metadata fields should be mapped to index fields.
`String`	`toString()` Returns a string representation of this object.
`ConfluenceSpaceConfiguration`	`withCrawlArchivedSpaces(Boolean crawlArchivedSpaces)` Specifies whether Amazon Kendra should index archived spaces.
`ConfluenceSpaceConfiguration`	`withCrawlPersonalSpaces(Boolean crawlPersonalSpaces)` Specifies whether Amazon Kendra should index personal spaces.
`ConfluenceSpaceConfiguration`	`withExcludeSpaces(Collection<String> excludeSpaces)` A list of space keys of Confluence spaces.
`ConfluenceSpaceConfiguration`	`withExcludeSpaces(String... excludeSpaces)` A list of space keys of Confluence spaces.
`ConfluenceSpaceConfiguration`	`withIncludeSpaces(Collection<String> includeSpaces)` A list of space keys for Confluence spaces.
`ConfluenceSpaceConfiguration`	`withIncludeSpaces(String... includeSpaces)` A list of space keys for Confluence spaces.
`ConfluenceSpaceConfiguration`	`withSpaceFieldMappings(Collection<ConfluenceSpaceToIndexFieldMapping> spaceFieldMappings)` Defines how space metadata fields should be mapped to index fields.
`ConfluenceSpaceConfiguration`	`withSpaceFieldMappings(ConfluenceSpaceToIndexFieldMapping... spaceFieldMappings)` Defines how space metadata fields should be mapped to index fields.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfluenceSpaceConfiguration
```
public ConfluenceSpaceConfiguration()
```
- Method Detail
  - setCrawlPersonalSpaces
```
public void setCrawlPersonalSpaces(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.
  - getCrawlPersonalSpaces
```
public Boolean getCrawlPersonalSpaces()
```
    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:
    
    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.
  - withCrawlPersonalSpaces
```
public ConfluenceSpaceConfiguration withCrawlPersonalSpaces(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.
  - isCrawlPersonalSpaces
```
public Boolean isCrawlPersonalSpaces()
```
    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:
    
    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.
  - setCrawlArchivedSpaces
```
public void setCrawlArchivedSpaces(Boolean crawlArchivedSpaces)
```
    Specifies whether Amazon Kendra should index archived spaces.
    
    Parameters:
    
    crawlArchivedSpaces - Specifies whether Amazon Kendra should index archived spaces.
  - getCrawlArchivedSpaces
```
public Boolean getCrawlArchivedSpaces()
```
    Specifies whether Amazon Kendra should index archived spaces.
    
    Returns:
    
    Specifies whether Amazon Kendra should index archived spaces.
  - withCrawlArchivedSpaces
```
public ConfluenceSpaceConfiguration withCrawlArchivedSpaces(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.
  - isCrawlArchivedSpaces
```
public Boolean isCrawlArchivedSpaces()
```
    Specifies whether Amazon Kendra should index archived spaces.
    
    Returns:
    
    Specifies whether Amazon Kendra should index archived spaces.
  - getIncludeSpaces
```
public List<String> getIncludeSpaces()
```
    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:
    
    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.
  - setIncludeSpaces
```
public void setIncludeSpaces(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.
  - withIncludeSpaces
```
public ConfluenceSpaceConfiguration withIncludeSpaces(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setIncludeSpaces(java.util.Collection) or withIncludeSpaces(java.util.Collection) if you want to override the existing values.
    
    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.
  - withIncludeSpaces
```
public ConfluenceSpaceConfiguration withIncludeSpaces(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.
  - getExcludeSpaces
```
public List<String> getExcludeSpaces()
```
    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:
    
    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.
  - setExcludeSpaces
```
public void setExcludeSpaces(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.
  - withExcludeSpaces
```
public ConfluenceSpaceConfiguration withExcludeSpaces(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludeSpaces(java.util.Collection) or withExcludeSpaces(java.util.Collection) if you want to override the existing values.
    
    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.
  - withExcludeSpaces
```
public ConfluenceSpaceConfiguration withExcludeSpaces(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.
  - getSpaceFieldMappings
```
public List<ConfluenceSpaceToIndexFieldMapping> getSpaceFieldMappings()
```
    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:
    
    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.
  - setSpaceFieldMappings
```
public void setSpaceFieldMappings(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.
  - withSpaceFieldMappings
```
public ConfluenceSpaceConfiguration withSpaceFieldMappings(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSpaceFieldMappings(java.util.Collection) or withSpaceFieldMappings(java.util.Collection) if you want to override the existing values.
    
    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.
  - withSpaceFieldMappings
```
public ConfluenceSpaceConfiguration withSpaceFieldMappings(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConfluenceSpaceConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ConfluenceSpaceConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfluenceSpaceConfiguration

Method Detail

setCrawlPersonalSpaces

getCrawlPersonalSpaces

withCrawlPersonalSpaces

isCrawlPersonalSpaces

setCrawlArchivedSpaces

getCrawlArchivedSpaces

withCrawlArchivedSpaces

isCrawlArchivedSpaces

getIncludeSpaces

setIncludeSpaces

withIncludeSpaces

withIncludeSpaces

getExcludeSpaces

setExcludeSpaces

withExcludeSpaces

withExcludeSpaces

getSpaceFieldMappings

setSpaceFieldMappings

withSpaceFieldMappings

withSpaceFieldMappings

toString

equals

hashCode

clone

marshall