software.amazon.awssdk.services.kendra.model

Class ConfluenceSpaceConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ConfluenceSpaceConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConfluenceSpaceConfiguration.Builder,ConfluenceSpaceConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ConfluenceSpaceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfluenceSpaceConfiguration.Builder,ConfluenceSpaceConfiguration>

Specifies the configuration for indexing Confluence spaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfluenceSpaceConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ConfluenceSpaceConfiguration.Builder	builder()
Boolean	crawlArchivedSpaces() Specifies whether Amazon Kendra should index archived spaces.
Boolean	crawlPersonalSpaces() Specifies whether Amazon Kendra should index personal spaces.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludeSpaces() A list of space keys of Confluence spaces.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludeSpaces() Returns true if the ExcludeSpaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasIncludeSpaces() Returns true if the IncludeSpaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSpaceFieldMappings() Returns true if the SpaceFieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	includeSpaces() A list of space keys for Confluence spaces.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfluenceSpaceConfiguration.Builder>	serializableBuilderClass()
List<ConfluenceSpaceToIndexFieldMapping>	spaceFieldMappings() Defines how space metadata fields should be mapped to index fields.
ConfluenceSpaceConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

crawlPersonalSpaces

public final 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.

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.

crawlArchivedSpaces

public final Boolean crawlArchivedSpaces()

Specifies whether Amazon Kendra should index archived spaces.

Returns:

Specifies whether Amazon Kendra should index archived spaces.

hasIncludeSpaces

public final boolean hasIncludeSpaces()

Returns true if the IncludeSpaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

includeSpaces

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIncludeSpaces() to see if a value was sent in this field.

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.

hasExcludeSpaces

public final boolean hasExcludeSpaces()

Returns true if the ExcludeSpaces property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

excludeSpaces

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasExcludeSpaces() to see if a value was sent in this field.

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.

hasSpaceFieldMappings

public final boolean hasSpaceFieldMappings()

Returns true if the SpaceFieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

spaceFieldMappings

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSpaceFieldMappings() to see if a value was sent in this field.

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.

toBuilder

public ConfluenceSpaceConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfluenceSpaceConfiguration.Builder,ConfluenceSpaceConfiguration>

builder

public static ConfluenceSpaceConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ConfluenceSpaceConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo