Aws::kendra::Model::ConfluenceSpaceConfiguration Class Reference

#include <ConfluenceSpaceConfiguration.h>

Public Member Functions
	ConfluenceSpaceConfiguration ()
	ConfluenceSpaceConfiguration (Aws::Utils::Json::JsonView jsonValue)
ConfluenceSpaceConfiguration &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
bool	GetCrawlPersonalSpaces () const
bool	CrawlPersonalSpacesHasBeenSet () const
void	SetCrawlPersonalSpaces (bool value)
ConfluenceSpaceConfiguration &	WithCrawlPersonalSpaces (bool value)
bool	GetCrawlArchivedSpaces () const
bool	CrawlArchivedSpacesHasBeenSet () const
void	SetCrawlArchivedSpaces (bool value)
ConfluenceSpaceConfiguration &	WithCrawlArchivedSpaces (bool value)
const Aws::Vector< Aws::String > &	GetIncludeSpaces () const
bool	IncludeSpacesHasBeenSet () const
void	SetIncludeSpaces (const Aws::Vector< Aws::String > &value)
void	SetIncludeSpaces (Aws::Vector< Aws::String > &&value)
ConfluenceSpaceConfiguration &	WithIncludeSpaces (const Aws::Vector< Aws::String > &value)
ConfluenceSpaceConfiguration &	WithIncludeSpaces (Aws::Vector< Aws::String > &&value)
ConfluenceSpaceConfiguration &	AddIncludeSpaces (const Aws::String &value)
ConfluenceSpaceConfiguration &	AddIncludeSpaces (Aws::String &&value)
ConfluenceSpaceConfiguration &	AddIncludeSpaces (const char *value)
const Aws::Vector< Aws::String > &	GetExcludeSpaces () const
bool	ExcludeSpacesHasBeenSet () const
void	SetExcludeSpaces (const Aws::Vector< Aws::String > &value)
void	SetExcludeSpaces (Aws::Vector< Aws::String > &&value)
ConfluenceSpaceConfiguration &	WithExcludeSpaces (const Aws::Vector< Aws::String > &value)
ConfluenceSpaceConfiguration &	WithExcludeSpaces (Aws::Vector< Aws::String > &&value)
ConfluenceSpaceConfiguration &	AddExcludeSpaces (const Aws::String &value)
ConfluenceSpaceConfiguration &	AddExcludeSpaces (Aws::String &&value)
ConfluenceSpaceConfiguration &	AddExcludeSpaces (const char *value)
const Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &	GetSpaceFieldMappings () const
bool	SpaceFieldMappingsHasBeenSet () const
void	SetSpaceFieldMappings (const Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &value)
void	SetSpaceFieldMappings (Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &&value)
ConfluenceSpaceConfiguration &	WithSpaceFieldMappings (const Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &value)
ConfluenceSpaceConfiguration &	WithSpaceFieldMappings (Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &&value)
ConfluenceSpaceConfiguration &	AddSpaceFieldMappings (const ConfluenceSpaceToIndexFieldMapping &value)
ConfluenceSpaceConfiguration &	AddSpaceFieldMappings (ConfluenceSpaceToIndexFieldMapping &&value)

Detailed Description

Specifies the configuration for indexing Confluence spaces.

See Also:

AWS API Reference

Definition at line 34 of file ConfluenceSpaceConfiguration.h.

Constructor & Destructor Documentation

ConfluenceSpaceConfiguration() [1/2]

Aws::kendra::Model::ConfluenceSpaceConfiguration::ConfluenceSpaceConfiguration

(

)

ConfluenceSpaceConfiguration() [2/2]

Aws::kendra::Model::ConfluenceSpaceConfiguration::ConfluenceSpaceConfiguration

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

AddExcludeSpaces() [1/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddExcludeSpaces ( Aws::String &&  value )

inline

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.

Definition at line 258 of file ConfluenceSpaceConfiguration.h.

AddExcludeSpaces() [2/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddExcludeSpaces ( const Aws::String &  value )

inline

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.

Definition at line 250 of file ConfluenceSpaceConfiguration.h.

AddExcludeSpaces() [3/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddExcludeSpaces ( const char *  value )

inline

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.

Definition at line 266 of file ConfluenceSpaceConfiguration.h.

AddIncludeSpaces() [1/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddIncludeSpaces ( Aws::String &&  value )

inline

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.

Definition at line 183 of file ConfluenceSpaceConfiguration.h.

AddIncludeSpaces() [2/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddIncludeSpaces ( const Aws::String &  value )

inline

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.

Definition at line 173 of file ConfluenceSpaceConfiguration.h.

AddIncludeSpaces() [3/3]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddIncludeSpaces ( const char *  value )

inline

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.

Definition at line 193 of file ConfluenceSpaceConfiguration.h.

AddSpaceFieldMappings() [1/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddSpaceFieldMappings ( ConfluenceSpaceToIndexFieldMapping &&  value )

inline

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.

Definition at line 339 of file ConfluenceSpaceConfiguration.h.

AddSpaceFieldMappings() [2/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::AddSpaceFieldMappings ( const ConfluenceSpaceToIndexFieldMapping &  value )

inline

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.

Definition at line 330 of file ConfluenceSpaceConfiguration.h.

CrawlArchivedSpacesHasBeenSet()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::CrawlArchivedSpacesHasBeenSet ( ) const

inline

Specifies whether Amazon Kendra should index archived spaces.

Definition at line 92 of file ConfluenceSpaceConfiguration.h.

CrawlPersonalSpacesHasBeenSet()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::CrawlPersonalSpacesHasBeenSet ( ) const

inline

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.

Definition at line 61 of file ConfluenceSpaceConfiguration.h.

ExcludeSpacesHasBeenSet()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::ExcludeSpacesHasBeenSet ( ) const

inline

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.

Definition at line 210 of file ConfluenceSpaceConfiguration.h.

GetCrawlArchivedSpaces()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::GetCrawlArchivedSpaces ( ) const

inline

Specifies whether Amazon Kendra should index archived spaces.

Definition at line 87 of file ConfluenceSpaceConfiguration.h.

GetCrawlPersonalSpaces()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::GetCrawlPersonalSpaces ( ) const

inline

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.

Definition at line 51 of file ConfluenceSpaceConfiguration.h.

GetExcludeSpaces()

const Aws::Vector<Aws::String>& Aws::kendra::Model::ConfluenceSpaceConfiguration::GetExcludeSpaces ( ) const

inline

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.

Definition at line 202 of file ConfluenceSpaceConfiguration.h.

GetIncludeSpaces()

const Aws::Vector<Aws::String>& Aws::kendra::Model::ConfluenceSpaceConfiguration::GetIncludeSpaces ( ) const

inline

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.

Definition at line 113 of file ConfluenceSpaceConfiguration.h.

GetSpaceFieldMappings()

const Aws::Vector<ConfluenceSpaceToIndexFieldMapping>& Aws::kendra::Model::ConfluenceSpaceConfiguration::GetSpaceFieldMappings ( ) const

inline

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.

Definition at line 276 of file ConfluenceSpaceConfiguration.h.

IncludeSpacesHasBeenSet()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::IncludeSpacesHasBeenSet ( ) const

inline

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.

Definition at line 123 of file ConfluenceSpaceConfiguration.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::ConfluenceSpaceConfiguration::Jsonize

(

)

const

operator=()

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

SetCrawlArchivedSpaces()

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetCrawlArchivedSpaces ( bool  value )

inline

Specifies whether Amazon Kendra should index archived spaces.

Definition at line 97 of file ConfluenceSpaceConfiguration.h.

SetCrawlPersonalSpaces()

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetCrawlPersonalSpaces ( bool  value )

inline

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.

Definition at line 71 of file ConfluenceSpaceConfiguration.h.

SetExcludeSpaces() [1/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetExcludeSpaces ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 226 of file ConfluenceSpaceConfiguration.h.

SetExcludeSpaces() [2/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetExcludeSpaces ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 218 of file ConfluenceSpaceConfiguration.h.

SetIncludeSpaces() [1/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetIncludeSpaces ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 143 of file ConfluenceSpaceConfiguration.h.

SetIncludeSpaces() [2/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetIncludeSpaces ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 133 of file ConfluenceSpaceConfiguration.h.

SetSpaceFieldMappings() [1/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetSpaceFieldMappings ( Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &&  value )

inline

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.

Definition at line 303 of file ConfluenceSpaceConfiguration.h.

SetSpaceFieldMappings() [2/2]

void Aws::kendra::Model::ConfluenceSpaceConfiguration::SetSpaceFieldMappings ( const Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &  value )

inline

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.

Definition at line 294 of file ConfluenceSpaceConfiguration.h.

SpaceFieldMappingsHasBeenSet()

bool Aws::kendra::Model::ConfluenceSpaceConfiguration::SpaceFieldMappingsHasBeenSet ( ) const

inline

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.

Definition at line 285 of file ConfluenceSpaceConfiguration.h.

WithCrawlArchivedSpaces()

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithCrawlArchivedSpaces ( bool  value )

inline

Specifies whether Amazon Kendra should index archived spaces.

Definition at line 102 of file ConfluenceSpaceConfiguration.h.

WithCrawlPersonalSpaces()

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithCrawlPersonalSpaces ( bool  value )

inline

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.

Definition at line 81 of file ConfluenceSpaceConfiguration.h.

WithExcludeSpaces() [1/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithExcludeSpaces ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 242 of file ConfluenceSpaceConfiguration.h.

WithExcludeSpaces() [2/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithExcludeSpaces ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 234 of file ConfluenceSpaceConfiguration.h.

WithIncludeSpaces() [1/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithIncludeSpaces ( Aws::Vector< Aws::String > &&  value )

inline

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.

Definition at line 163 of file ConfluenceSpaceConfiguration.h.

WithIncludeSpaces() [2/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithIncludeSpaces ( const Aws::Vector< Aws::String > &  value )

inline

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.

Definition at line 153 of file ConfluenceSpaceConfiguration.h.

WithSpaceFieldMappings() [1/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithSpaceFieldMappings ( Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &&  value )

inline

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.

Definition at line 321 of file ConfluenceSpaceConfiguration.h.

WithSpaceFieldMappings() [2/2]

ConfluenceSpaceConfiguration& Aws::kendra::Model::ConfluenceSpaceConfiguration::WithSpaceFieldMappings ( const Aws::Vector< ConfluenceSpaceToIndexFieldMapping > &  value )

inline

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.

Definition at line 312 of file ConfluenceSpaceConfiguration.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-kendra/include/aws/kendra/model/ConfluenceSpaceConfiguration.h