ConfluenceSpaceConfiguration (AWS Java SDK :: Services

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>

Configuration information for indexing Confluence spaces.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ConfluenceSpaceConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConfluenceSpaceConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConfluenceSpaceConfiguration.Builder`	`builder()`
`Boolean`	`crawlArchivedSpaces()` `TRUE` to index archived spaces.
`Boolean`	`crawlPersonalSpaces()` `TRUE` to 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()` For responses, this returns true if the service returned a value for the ExcludeSpaces property.
`int`	`hashCode()`
`boolean`	`hasIncludeSpaces()` For responses, this returns true if the service returned a value for the IncludeSpaces property.
`boolean`	`hasSpaceFieldMappings()` For responses, this returns true if the service returned a value for the SpaceFieldMappings property.
`List<String>`	`includeSpaces()` A list of space keys for Confluence spaces.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConfluenceSpaceConfiguration.Builder>`	`serializableBuilderClass()`
`List<ConfluenceSpaceToIndexFieldMapping>`	`spaceFieldMappings()` Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.
`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()
```
    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:
    
    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.
  - crawlArchivedSpaces
```
public final Boolean crawlArchivedSpaces()
```
    TRUE to index archived spaces.
    
    Returns:
    
    TRUE to index archived spaces.
  - hasIncludeSpaces
```
public final boolean hasIncludeSpaces()
```
    For responses, this returns true if the service returned a value for the IncludeSpaces property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeSpaces() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the ExcludeSpaces property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeSpaces() method.
    
    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()
```
    For responses, this returns true if the service returned a value for the SpaceFieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - spaceFieldMappings
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSpaceFieldMappings() method.
    
    Returns:
    
    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.
  - 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

Class ConfluenceSpaceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

crawlPersonalSpaces

crawlArchivedSpaces

hasIncludeSpaces

includeSpaces

hasExcludeSpaces

excludeSpaces

hasSpaceFieldMappings

spaceFieldMappings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields