Struct S3DataSourceConfigurationBuilder 

#[non_exhaustive]
pub struct S3DataSourceConfigurationBuilder { /* private fields */ }

A builder for S3DataSourceConfiguration.

Implementations

impl S3DataSourceConfigurationBuilder

pub fn bucket_name(self, input: impl Into<String>) -> Self

The name of the bucket that contains the documents.

This field is required.

pub fn set_bucket_name(self, input: Option<String>) -> Self

The name of the bucket that contains the documents.

pub fn get_bucket_name(&self) -> &Option<String>

The name of the bucket that contains the documents.

pub fn inclusion_prefixes(self, input: impl Into<String>) -> Self

Appends an item to inclusion_prefixes.

To override the contents of this collection use set_inclusion_prefixes.

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

pub fn set_inclusion_prefixes(self, input: Option<Vec<String>>) -> Self

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

pub fn get_inclusion_prefixes(&self) -> &Option<Vec<String>>

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

pub fn inclusion_patterns(self, input: impl Into<String>) -> Self

Appends an item to inclusion_patterns.

To override the contents of this collection use set_inclusion_patterns.

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn set_inclusion_patterns(self, input: Option<Vec<String>>) -> Self

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn get_inclusion_patterns(&self) -> &Option<Vec<String>>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn exclusion_patterns(self, input: impl Into<String>) -> Self

Appends an item to exclusion_patterns.

To override the contents of this collection use set_exclusion_patterns.

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn set_exclusion_patterns(self, input: Option<Vec<String>>) -> Self

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn get_exclusion_patterns(&self) -> &Option<Vec<String>>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

• /myapp/config/*—All files inside config directory.

• **/*.png—All .png files in all directories.

• **/*.{png, ico, md}—All .png, .ico or .md files in all directories.

• /myapp/src/**/*.ts—All .ts files inside src directory (and all its subdirectories).

• **/!(*.module).ts—All .ts files but not .module.ts

• *.png , *.jpg—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

• *internal*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

• **/*internal*—All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the Amazon Web Services CLI Command Reference.

pub fn documents_metadata_configuration( self, input: DocumentsMetadataConfiguration, ) -> Self

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

pub fn set_documents_metadata_configuration( self, input: Option<DocumentsMetadataConfiguration>, ) -> Self

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

pub fn get_documents_metadata_configuration( &self, ) -> &Option<DocumentsMetadataConfiguration>

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

pub fn access_control_list_configuration( self, input: AccessControlListConfiguration, ) -> Self

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.

pub fn set_access_control_list_configuration( self, input: Option<AccessControlListConfiguration>, ) -> Self

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.

pub fn get_access_control_list_configuration( &self, ) -> &Option<AccessControlListConfiguration>

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.

pub fn build(self) -> Result<S3DataSourceConfiguration, BuildError>

Consumes the builder and constructs a S3DataSourceConfiguration. This method will fail if any of the following fields are not set:

• bucket_name

Trait Implementations

impl Clone for S3DataSourceConfigurationBuilder

fn clone(&self) -> S3DataSourceConfigurationBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3DataSourceConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for S3DataSourceConfigurationBuilder

fn default() -> S3DataSourceConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for S3DataSourceConfigurationBuilder

fn eq(&self, other: &S3DataSourceConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3DataSourceConfigurationBuilder