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

#include <S3DataSourceConfiguration.h>

Public Member Functions

 S3DataSourceConfiguration ()
 
 S3DataSourceConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
S3DataSourceConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBucketName () const
 
bool BucketNameHasBeenSet () const
 
void SetBucketName (const Aws::String &value)
 
void SetBucketName (Aws::String &&value)
 
void SetBucketName (const char *value)
 
S3DataSourceConfigurationWithBucketName (const Aws::String &value)
 
S3DataSourceConfigurationWithBucketName (Aws::String &&value)
 
S3DataSourceConfigurationWithBucketName (const char *value)
 
const Aws::Vector< Aws::String > & GetInclusionPrefixes () const
 
bool InclusionPrefixesHasBeenSet () const
 
void SetInclusionPrefixes (const Aws::Vector< Aws::String > &value)
 
void SetInclusionPrefixes (Aws::Vector< Aws::String > &&value)
 
S3DataSourceConfigurationWithInclusionPrefixes (const Aws::Vector< Aws::String > &value)
 
S3DataSourceConfigurationWithInclusionPrefixes (Aws::Vector< Aws::String > &&value)
 
S3DataSourceConfigurationAddInclusionPrefixes (const Aws::String &value)
 
S3DataSourceConfigurationAddInclusionPrefixes (Aws::String &&value)
 
S3DataSourceConfigurationAddInclusionPrefixes (const char *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)
 
S3DataSourceConfigurationWithInclusionPatterns (const Aws::Vector< Aws::String > &value)
 
S3DataSourceConfigurationWithInclusionPatterns (Aws::Vector< Aws::String > &&value)
 
S3DataSourceConfigurationAddInclusionPatterns (const Aws::String &value)
 
S3DataSourceConfigurationAddInclusionPatterns (Aws::String &&value)
 
S3DataSourceConfigurationAddInclusionPatterns (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)
 
S3DataSourceConfigurationWithExclusionPatterns (const Aws::Vector< Aws::String > &value)
 
S3DataSourceConfigurationWithExclusionPatterns (Aws::Vector< Aws::String > &&value)
 
S3DataSourceConfigurationAddExclusionPatterns (const Aws::String &value)
 
S3DataSourceConfigurationAddExclusionPatterns (Aws::String &&value)
 
S3DataSourceConfigurationAddExclusionPatterns (const char *value)
 
const DocumentsMetadataConfigurationGetDocumentsMetadataConfiguration () const
 
bool DocumentsMetadataConfigurationHasBeenSet () const
 
void SetDocumentsMetadataConfiguration (const DocumentsMetadataConfiguration &value)
 
void SetDocumentsMetadataConfiguration (DocumentsMetadataConfiguration &&value)
 
S3DataSourceConfigurationWithDocumentsMetadataConfiguration (const DocumentsMetadataConfiguration &value)
 
S3DataSourceConfigurationWithDocumentsMetadataConfiguration (DocumentsMetadataConfiguration &&value)
 
const AccessControlListConfigurationGetAccessControlListConfiguration () const
 
bool AccessControlListConfigurationHasBeenSet () const
 
void SetAccessControlListConfiguration (const AccessControlListConfiguration &value)
 
void SetAccessControlListConfiguration (AccessControlListConfiguration &&value)
 
S3DataSourceConfigurationWithAccessControlListConfiguration (const AccessControlListConfiguration &value)
 
S3DataSourceConfigurationWithAccessControlListConfiguration (AccessControlListConfiguration &&value)
 

Detailed Description

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

See Also:

AWS API Reference

Definition at line 35 of file S3DataSourceConfiguration.h.

Constructor & Destructor Documentation

◆ S3DataSourceConfiguration() [1/2]

Aws::kendra::Model::S3DataSourceConfiguration::S3DataSourceConfiguration ( )

◆ S3DataSourceConfiguration() [2/2]

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

Member Function Documentation

◆ AccessControlListConfigurationHasBeenSet()

bool Aws::kendra::Model::S3DataSourceConfiguration::AccessControlListConfigurationHasBeenSet ( ) const
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 346 of file S3DataSourceConfiguration.h.

◆ AddExclusionPatterns() [1/3]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 300 of file S3DataSourceConfiguration.h.

◆ AddExclusionPatterns() [2/3]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 290 of file S3DataSourceConfiguration.h.

◆ AddExclusionPatterns() [3/3]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 310 of file S3DataSourceConfiguration.h.

◆ AddInclusionPatterns() [1/3]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 210 of file S3DataSourceConfiguration.h.

◆ AddInclusionPatterns() [2/3]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 201 of file S3DataSourceConfiguration.h.

◆ AddInclusionPatterns() [3/3]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 219 of file S3DataSourceConfiguration.h.

◆ AddInclusionPrefixes() [1/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::AddInclusionPrefixes ( Aws::String &&  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 131 of file S3DataSourceConfiguration.h.

◆ AddInclusionPrefixes() [2/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::AddInclusionPrefixes ( const Aws::String value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 125 of file S3DataSourceConfiguration.h.

◆ AddInclusionPrefixes() [3/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::AddInclusionPrefixes ( const char *  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 137 of file S3DataSourceConfiguration.h.

◆ BucketNameHasBeenSet()

bool Aws::kendra::Model::S3DataSourceConfiguration::BucketNameHasBeenSet ( ) const
inline

The name of the bucket that contains the documents.

Definition at line 52 of file S3DataSourceConfiguration.h.

◆ DocumentsMetadataConfigurationHasBeenSet()

bool Aws::kendra::Model::S3DataSourceConfiguration::DocumentsMetadataConfigurationHasBeenSet ( ) const
inline

Definition at line 317 of file S3DataSourceConfiguration.h.

◆ ExclusionPatternsHasBeenSet()

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 240 of file S3DataSourceConfiguration.h.

◆ GetAccessControlListConfiguration()

const AccessControlListConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::GetAccessControlListConfiguration ( ) const
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 338 of file S3DataSourceConfiguration.h.

◆ GetBucketName()

const Aws::String& Aws::kendra::Model::S3DataSourceConfiguration::GetBucketName ( ) const
inline

The name of the bucket that contains the documents.

Definition at line 47 of file S3DataSourceConfiguration.h.

◆ GetDocumentsMetadataConfiguration()

const DocumentsMetadataConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::GetDocumentsMetadataConfiguration ( ) const
inline

Definition at line 314 of file S3DataSourceConfiguration.h.

◆ GetExclusionPatterns()

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 230 of file S3DataSourceConfiguration.h.

◆ GetInclusionPatterns()

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 147 of file S3DataSourceConfiguration.h.

◆ GetInclusionPrefixes()

const Aws::Vector<Aws::String>& Aws::kendra::Model::S3DataSourceConfiguration::GetInclusionPrefixes ( ) const
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 89 of file S3DataSourceConfiguration.h.

◆ InclusionPatternsHasBeenSet()

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 156 of file S3DataSourceConfiguration.h.

◆ InclusionPrefixesHasBeenSet()

bool Aws::kendra::Model::S3DataSourceConfiguration::InclusionPrefixesHasBeenSet ( ) const
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 95 of file S3DataSourceConfiguration.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetAccessControlListConfiguration() [1/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetAccessControlListConfiguration ( AccessControlListConfiguration &&  value)
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 362 of file S3DataSourceConfiguration.h.

◆ SetAccessControlListConfiguration() [2/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetAccessControlListConfiguration ( const AccessControlListConfiguration value)
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 354 of file S3DataSourceConfiguration.h.

◆ SetBucketName() [1/3]

void Aws::kendra::Model::S3DataSourceConfiguration::SetBucketName ( Aws::String &&  value)
inline

The name of the bucket that contains the documents.

Definition at line 62 of file S3DataSourceConfiguration.h.

◆ SetBucketName() [2/3]

void Aws::kendra::Model::S3DataSourceConfiguration::SetBucketName ( const Aws::String value)
inline

The name of the bucket that contains the documents.

Definition at line 57 of file S3DataSourceConfiguration.h.

◆ SetBucketName() [3/3]

void Aws::kendra::Model::S3DataSourceConfiguration::SetBucketName ( const char *  value)
inline

The name of the bucket that contains the documents.

Definition at line 67 of file S3DataSourceConfiguration.h.

◆ SetDocumentsMetadataConfiguration() [1/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetDocumentsMetadataConfiguration ( const DocumentsMetadataConfiguration value)
inline

Definition at line 320 of file S3DataSourceConfiguration.h.

◆ SetDocumentsMetadataConfiguration() [2/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetDocumentsMetadataConfiguration ( DocumentsMetadataConfiguration &&  value)
inline

Definition at line 323 of file S3DataSourceConfiguration.h.

◆ SetExclusionPatterns() [1/2]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 260 of file S3DataSourceConfiguration.h.

◆ SetExclusionPatterns() [2/2]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 250 of file S3DataSourceConfiguration.h.

◆ SetInclusionPatterns() [1/2]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 174 of file S3DataSourceConfiguration.h.

◆ SetInclusionPatterns() [2/2]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 165 of file S3DataSourceConfiguration.h.

◆ SetInclusionPrefixes() [1/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetInclusionPrefixes ( Aws::Vector< Aws::String > &&  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 107 of file S3DataSourceConfiguration.h.

◆ SetInclusionPrefixes() [2/2]

void Aws::kendra::Model::S3DataSourceConfiguration::SetInclusionPrefixes ( const Aws::Vector< Aws::String > &  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 101 of file S3DataSourceConfiguration.h.

◆ WithAccessControlListConfiguration() [1/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithAccessControlListConfiguration ( AccessControlListConfiguration &&  value)
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 378 of file S3DataSourceConfiguration.h.

◆ WithAccessControlListConfiguration() [2/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithAccessControlListConfiguration ( const AccessControlListConfiguration value)
inline

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Definition at line 370 of file S3DataSourceConfiguration.h.

◆ WithBucketName() [1/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithBucketName ( Aws::String &&  value)
inline

The name of the bucket that contains the documents.

Definition at line 77 of file S3DataSourceConfiguration.h.

◆ WithBucketName() [2/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithBucketName ( const Aws::String value)
inline

The name of the bucket that contains the documents.

Definition at line 72 of file S3DataSourceConfiguration.h.

◆ WithBucketName() [3/3]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithBucketName ( const char *  value)
inline

The name of the bucket that contains the documents.

Definition at line 82 of file S3DataSourceConfiguration.h.

◆ WithDocumentsMetadataConfiguration() [1/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithDocumentsMetadataConfiguration ( const DocumentsMetadataConfiguration value)
inline

Definition at line 326 of file S3DataSourceConfiguration.h.

◆ WithDocumentsMetadataConfiguration() [2/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithDocumentsMetadataConfiguration ( DocumentsMetadataConfiguration &&  value)
inline

Definition at line 329 of file S3DataSourceConfiguration.h.

◆ WithExclusionPatterns() [1/2]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 280 of file S3DataSourceConfiguration.h.

◆ WithExclusionPatterns() [2/2]

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

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 270 of file S3DataSourceConfiguration.h.

◆ WithInclusionPatterns() [1/2]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 192 of file S3DataSourceConfiguration.h.

◆ WithInclusionPatterns() [2/2]

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

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Definition at line 183 of file S3DataSourceConfiguration.h.

◆ WithInclusionPrefixes() [1/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithInclusionPrefixes ( Aws::Vector< Aws::String > &&  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 119 of file S3DataSourceConfiguration.h.

◆ WithInclusionPrefixes() [2/2]

S3DataSourceConfiguration& Aws::kendra::Model::S3DataSourceConfiguration::WithInclusionPrefixes ( const Aws::Vector< Aws::String > &  value)
inline

A list of S3 prefixes for the documents that should be included in the index.

Definition at line 113 of file S3DataSourceConfiguration.h.


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