AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::SharePointConfiguration Class Reference

#include <SharePointConfiguration.h>

Public Member Functions

 SharePointConfiguration ()
 
 SharePointConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
SharePointConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const SharePointVersionGetSharePointVersion () const
 
bool SharePointVersionHasBeenSet () const
 
void SetSharePointVersion (const SharePointVersion &value)
 
void SetSharePointVersion (SharePointVersion &&value)
 
SharePointConfigurationWithSharePointVersion (const SharePointVersion &value)
 
SharePointConfigurationWithSharePointVersion (SharePointVersion &&value)
 
const Aws::Vector< Aws::String > & GetUrls () const
 
bool UrlsHasBeenSet () const
 
void SetUrls (const Aws::Vector< Aws::String > &value)
 
void SetUrls (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationWithUrls (const Aws::Vector< Aws::String > &value)
 
SharePointConfigurationWithUrls (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationAddUrls (const Aws::String &value)
 
SharePointConfigurationAddUrls (Aws::String &&value)
 
SharePointConfigurationAddUrls (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
SharePointConfigurationWithSecretArn (const Aws::String &value)
 
SharePointConfigurationWithSecretArn (Aws::String &&value)
 
SharePointConfigurationWithSecretArn (const char *value)
 
bool GetCrawlAttachments () const
 
bool CrawlAttachmentsHasBeenSet () const
 
void SetCrawlAttachments (bool value)
 
SharePointConfigurationWithCrawlAttachments (bool value)
 
bool GetUseChangeLog () const
 
bool UseChangeLogHasBeenSet () const
 
void SetUseChangeLog (bool value)
 
SharePointConfigurationWithUseChangeLog (bool value)
 
const Aws::Vector< Aws::String > & GetInclusionPatterns () const
 
bool InclusionPatternsHasBeenSet () const
 
void SetInclusionPatterns (const Aws::Vector< Aws::String > &value)
 
void SetInclusionPatterns (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationWithInclusionPatterns (const Aws::Vector< Aws::String > &value)
 
SharePointConfigurationWithInclusionPatterns (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationAddInclusionPatterns (const Aws::String &value)
 
SharePointConfigurationAddInclusionPatterns (Aws::String &&value)
 
SharePointConfigurationAddInclusionPatterns (const char *value)
 
const Aws::Vector< Aws::String > & GetExclusionPatterns () const
 
bool ExclusionPatternsHasBeenSet () const
 
void SetExclusionPatterns (const Aws::Vector< Aws::String > &value)
 
void SetExclusionPatterns (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationWithExclusionPatterns (const Aws::Vector< Aws::String > &value)
 
SharePointConfigurationWithExclusionPatterns (Aws::Vector< Aws::String > &&value)
 
SharePointConfigurationAddExclusionPatterns (const Aws::String &value)
 
SharePointConfigurationAddExclusionPatterns (Aws::String &&value)
 
SharePointConfigurationAddExclusionPatterns (const char *value)
 
const DataSourceVpcConfigurationGetVpcConfiguration () const
 
bool VpcConfigurationHasBeenSet () const
 
void SetVpcConfiguration (const DataSourceVpcConfiguration &value)
 
void SetVpcConfiguration (DataSourceVpcConfiguration &&value)
 
SharePointConfigurationWithVpcConfiguration (const DataSourceVpcConfiguration &value)
 
SharePointConfigurationWithVpcConfiguration (DataSourceVpcConfiguration &&value)
 
const Aws::Vector< DataSourceToIndexFieldMapping > & GetFieldMappings () const
 
bool FieldMappingsHasBeenSet () const
 
void SetFieldMappings (const Aws::Vector< DataSourceToIndexFieldMapping > &value)
 
void SetFieldMappings (Aws::Vector< DataSourceToIndexFieldMapping > &&value)
 
SharePointConfigurationWithFieldMappings (const Aws::Vector< DataSourceToIndexFieldMapping > &value)
 
SharePointConfigurationWithFieldMappings (Aws::Vector< DataSourceToIndexFieldMapping > &&value)
 
SharePointConfigurationAddFieldMappings (const DataSourceToIndexFieldMapping &value)
 
SharePointConfigurationAddFieldMappings (DataSourceToIndexFieldMapping &&value)
 
const Aws::StringGetDocumentTitleFieldName () const
 
bool DocumentTitleFieldNameHasBeenSet () const
 
void SetDocumentTitleFieldName (const Aws::String &value)
 
void SetDocumentTitleFieldName (Aws::String &&value)
 
void SetDocumentTitleFieldName (const char *value)
 
SharePointConfigurationWithDocumentTitleFieldName (const Aws::String &value)
 
SharePointConfigurationWithDocumentTitleFieldName (Aws::String &&value)
 
SharePointConfigurationWithDocumentTitleFieldName (const char *value)
 
bool GetDisableLocalGroups () const
 
bool DisableLocalGroupsHasBeenSet () const
 
void SetDisableLocalGroups (bool value)
 
SharePointConfigurationWithDisableLocalGroups (bool value)
 

Detailed Description

Provides configuration information for connecting to a Microsoft SharePoint data source.

See Also:

AWS API Reference

Definition at line 36 of file SharePointConfiguration.h.

Constructor & Destructor Documentation

◆ SharePointConfiguration() [1/2]

Aws::kendra::Model::SharePointConfiguration::SharePointConfiguration ( )

◆ SharePointConfiguration() [2/2]

Aws::kendra::Model::SharePointConfiguration::SharePointConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddExclusionPatterns() [1/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddExclusionPatterns ( Aws::String &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 442 of file SharePointConfiguration.h.

◆ AddExclusionPatterns() [2/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddExclusionPatterns ( const Aws::String value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 433 of file SharePointConfiguration.h.

◆ AddExclusionPatterns() [3/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddExclusionPatterns ( const char *  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 451 of file SharePointConfiguration.h.

◆ AddFieldMappings() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddFieldMappings ( const DataSourceToIndexFieldMapping value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 541 of file SharePointConfiguration.h.

◆ AddFieldMappings() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddFieldMappings ( DataSourceToIndexFieldMapping &&  value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 551 of file SharePointConfiguration.h.

◆ AddInclusionPatterns() [1/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddInclusionPatterns ( Aws::String &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 360 of file SharePointConfiguration.h.

◆ AddInclusionPatterns() [2/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddInclusionPatterns ( const Aws::String value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 351 of file SharePointConfiguration.h.

◆ AddInclusionPatterns() [3/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddInclusionPatterns ( const char *  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 369 of file SharePointConfiguration.h.

◆ AddUrls() [1/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddUrls ( Aws::String &&  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 122 of file SharePointConfiguration.h.

◆ AddUrls() [2/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddUrls ( const Aws::String value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 116 of file SharePointConfiguration.h.

◆ AddUrls() [3/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::AddUrls ( const char *  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 128 of file SharePointConfiguration.h.

◆ CrawlAttachmentsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::CrawlAttachmentsHasBeenSet ( ) const
inline

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

Definition at line 238 of file SharePointConfiguration.h.

◆ DisableLocalGroupsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::DisableLocalGroupsHasBeenSet ( ) const
inline

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

Definition at line 613 of file SharePointConfiguration.h.

◆ DocumentTitleFieldNameHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::DocumentTitleFieldNameHasBeenSet ( ) const
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 564 of file SharePointConfiguration.h.

◆ ExclusionPatternsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::ExclusionPatternsHasBeenSet ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 388 of file SharePointConfiguration.h.

◆ FieldMappingsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::FieldMappingsHasBeenSet ( ) const
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 491 of file SharePointConfiguration.h.

◆ GetCrawlAttachments()

bool Aws::kendra::Model::SharePointConfiguration::GetCrawlAttachments ( ) const
inline

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

Definition at line 232 of file SharePointConfiguration.h.

◆ GetDisableLocalGroups()

bool Aws::kendra::Model::SharePointConfiguration::GetDisableLocalGroups ( ) const
inline

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

Definition at line 607 of file SharePointConfiguration.h.

◆ GetDocumentTitleFieldName()

const Aws::String& Aws::kendra::Model::SharePointConfiguration::GetDocumentTitleFieldName ( ) const
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 558 of file SharePointConfiguration.h.

◆ GetExclusionPatterns()

const Aws::Vector<Aws::String>& Aws::kendra::Model::SharePointConfiguration::GetExclusionPatterns ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 379 of file SharePointConfiguration.h.

◆ GetFieldMappings()

const Aws::Vector<DataSourceToIndexFieldMapping>& Aws::kendra::Model::SharePointConfiguration::GetFieldMappings ( ) const
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 481 of file SharePointConfiguration.h.

◆ GetInclusionPatterns()

const Aws::Vector<Aws::String>& Aws::kendra::Model::SharePointConfiguration::GetInclusionPatterns ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 297 of file SharePointConfiguration.h.

◆ GetSecretArn()

const Aws::String& Aws::kendra::Model::SharePointConfiguration::GetSecretArn ( ) const
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 141 of file SharePointConfiguration.h.

◆ GetSharePointVersion()

const SharePointVersion& Aws::kendra::Model::SharePointConfiguration::GetSharePointVersion ( ) const
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 48 of file SharePointConfiguration.h.

◆ GetUrls()

const Aws::Vector<Aws::String>& Aws::kendra::Model::SharePointConfiguration::GetUrls ( ) const
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 80 of file SharePointConfiguration.h.

◆ GetUseChangeLog()

bool Aws::kendra::Model::SharePointConfiguration::GetUseChangeLog ( ) const
inline

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

Definition at line 260 of file SharePointConfiguration.h.

◆ GetVpcConfiguration()

const DataSourceVpcConfiguration& Aws::kendra::Model::SharePointConfiguration::GetVpcConfiguration ( ) const
inline

Definition at line 455 of file SharePointConfiguration.h.

◆ InclusionPatternsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::InclusionPatternsHasBeenSet ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 306 of file SharePointConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::SharePointConfiguration::Jsonize ( ) const

◆ operator=()

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretArnHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::SecretArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 153 of file SharePointConfiguration.h.

◆ SetCrawlAttachments()

void Aws::kendra::Model::SharePointConfiguration::SetCrawlAttachments ( bool  value)
inline

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

Definition at line 244 of file SharePointConfiguration.h.

◆ SetDisableLocalGroups()

void Aws::kendra::Model::SharePointConfiguration::SetDisableLocalGroups ( bool  value)
inline

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

Definition at line 619 of file SharePointConfiguration.h.

◆ SetDocumentTitleFieldName() [1/3]

void Aws::kendra::Model::SharePointConfiguration::SetDocumentTitleFieldName ( Aws::String &&  value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 576 of file SharePointConfiguration.h.

◆ SetDocumentTitleFieldName() [2/3]

void Aws::kendra::Model::SharePointConfiguration::SetDocumentTitleFieldName ( const Aws::String value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 570 of file SharePointConfiguration.h.

◆ SetDocumentTitleFieldName() [3/3]

void Aws::kendra::Model::SharePointConfiguration::SetDocumentTitleFieldName ( const char *  value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 582 of file SharePointConfiguration.h.

◆ SetExclusionPatterns() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetExclusionPatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 406 of file SharePointConfiguration.h.

◆ SetExclusionPatterns() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetExclusionPatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 397 of file SharePointConfiguration.h.

◆ SetFieldMappings() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetFieldMappings ( Aws::Vector< DataSourceToIndexFieldMapping > &&  value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 511 of file SharePointConfiguration.h.

◆ SetFieldMappings() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetFieldMappings ( const Aws::Vector< DataSourceToIndexFieldMapping > &  value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 501 of file SharePointConfiguration.h.

◆ SetInclusionPatterns() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetInclusionPatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 324 of file SharePointConfiguration.h.

◆ SetInclusionPatterns() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetInclusionPatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 315 of file SharePointConfiguration.h.

◆ SetSecretArn() [1/3]

void Aws::kendra::Model::SharePointConfiguration::SetSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 177 of file SharePointConfiguration.h.

◆ SetSecretArn() [2/3]

void Aws::kendra::Model::SharePointConfiguration::SetSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 165 of file SharePointConfiguration.h.

◆ SetSecretArn() [3/3]

void Aws::kendra::Model::SharePointConfiguration::SetSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 189 of file SharePointConfiguration.h.

◆ SetSharePointVersion() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetSharePointVersion ( const SharePointVersion value)
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 58 of file SharePointConfiguration.h.

◆ SetSharePointVersion() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetSharePointVersion ( SharePointVersion &&  value)
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 63 of file SharePointConfiguration.h.

◆ SetUrls() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetUrls ( Aws::Vector< Aws::String > &&  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 98 of file SharePointConfiguration.h.

◆ SetUrls() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetUrls ( const Aws::Vector< Aws::String > &  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 92 of file SharePointConfiguration.h.

◆ SetUseChangeLog()

void Aws::kendra::Model::SharePointConfiguration::SetUseChangeLog ( bool  value)
inline

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

Definition at line 278 of file SharePointConfiguration.h.

◆ SetVpcConfiguration() [1/2]

void Aws::kendra::Model::SharePointConfiguration::SetVpcConfiguration ( const DataSourceVpcConfiguration value)
inline

Definition at line 461 of file SharePointConfiguration.h.

◆ SetVpcConfiguration() [2/2]

void Aws::kendra::Model::SharePointConfiguration::SetVpcConfiguration ( DataSourceVpcConfiguration &&  value)
inline

Definition at line 464 of file SharePointConfiguration.h.

◆ SharePointVersionHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::SharePointVersionHasBeenSet ( ) const
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 53 of file SharePointConfiguration.h.

◆ UrlsHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::UrlsHasBeenSet ( ) const
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 86 of file SharePointConfiguration.h.

◆ UseChangeLogHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::UseChangeLogHasBeenSet ( ) const
inline

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

Definition at line 269 of file SharePointConfiguration.h.

◆ VpcConfigurationHasBeenSet()

bool Aws::kendra::Model::SharePointConfiguration::VpcConfigurationHasBeenSet ( ) const
inline

Definition at line 458 of file SharePointConfiguration.h.

◆ WithCrawlAttachments()

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithCrawlAttachments ( bool  value)
inline

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

Definition at line 250 of file SharePointConfiguration.h.

◆ WithDisableLocalGroups()

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithDisableLocalGroups ( bool  value)
inline

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

Definition at line 625 of file SharePointConfiguration.h.

◆ WithDocumentTitleFieldName() [1/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithDocumentTitleFieldName ( Aws::String &&  value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 594 of file SharePointConfiguration.h.

◆ WithDocumentTitleFieldName() [2/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithDocumentTitleFieldName ( const Aws::String value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 588 of file SharePointConfiguration.h.

◆ WithDocumentTitleFieldName() [3/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithDocumentTitleFieldName ( const char *  value)
inline

The Microsoft SharePoint attribute field that contains the title of the document.

Definition at line 600 of file SharePointConfiguration.h.

◆ WithExclusionPatterns() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithExclusionPatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 424 of file SharePointConfiguration.h.

◆ WithExclusionPatterns() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithExclusionPatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 415 of file SharePointConfiguration.h.

◆ WithFieldMappings() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithFieldMappings ( Aws::Vector< DataSourceToIndexFieldMapping > &&  value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 531 of file SharePointConfiguration.h.

◆ WithFieldMappings() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithFieldMappings ( const Aws::Vector< DataSourceToIndexFieldMapping > &  value)
inline

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

Definition at line 521 of file SharePointConfiguration.h.

◆ WithInclusionPatterns() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithInclusionPatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 342 of file SharePointConfiguration.h.

◆ WithInclusionPatterns() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithInclusionPatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

Definition at line 333 of file SharePointConfiguration.h.

◆ WithSecretArn() [1/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 213 of file SharePointConfiguration.h.

◆ WithSecretArn() [2/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 201 of file SharePointConfiguration.h.

◆ WithSecretArn() [3/3]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

Definition at line 225 of file SharePointConfiguration.h.

◆ WithSharePointVersion() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithSharePointVersion ( const SharePointVersion value)
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 68 of file SharePointConfiguration.h.

◆ WithSharePointVersion() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithSharePointVersion ( SharePointVersion &&  value)
inline

The version of Microsoft SharePoint that you are using as a data source.

Definition at line 73 of file SharePointConfiguration.h.

◆ WithUrls() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithUrls ( Aws::Vector< Aws::String > &&  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 110 of file SharePointConfiguration.h.

◆ WithUrls() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithUrls ( const Aws::Vector< Aws::String > &  value)
inline

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

Definition at line 104 of file SharePointConfiguration.h.

◆ WithUseChangeLog()

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithUseChangeLog ( bool  value)
inline

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

Definition at line 287 of file SharePointConfiguration.h.

◆ WithVpcConfiguration() [1/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithVpcConfiguration ( const DataSourceVpcConfiguration value)
inline

Definition at line 467 of file SharePointConfiguration.h.

◆ WithVpcConfiguration() [2/2]

SharePointConfiguration& Aws::kendra::Model::SharePointConfiguration::WithVpcConfiguration ( DataSourceVpcConfiguration &&  value)
inline

Definition at line 470 of file SharePointConfiguration.h.


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