Struct AlfrescoConfigurationBuilder 

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

A builder for AlfrescoConfiguration.

Implementations

impl AlfrescoConfigurationBuilder

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

The URL of the Alfresco site. For example, https://hostname:8080.

This field is required.

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

The URL of the Alfresco site. For example, https://hostname:8080.

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

The URL of the Alfresco site. For example, https://hostname:8080.

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

The identifier of the Alfresco site. For example, my-site.

This field is required.

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

The identifier of the Alfresco site. For example, my-site.

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

The identifier of the Alfresco site. For example, my-site.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

• username—The user name of the Alfresco account.

• password—The password of the Alfresco account.

This field is required.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

• username—The user name of the Alfresco account.

• password—The password of the Alfresco account.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

• username—The user name of the Alfresco account.

• password—The password of the Alfresco account.

pub fn ssl_certificate_s3_path(self, input: S3Path) -> Self

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

This field is required.

pub fn set_ssl_certificate_s3_path(self, input: Option<S3Path>) -> Self

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

pub fn get_ssl_certificate_s3_path(&self) -> &Option<S3Path>

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

pub fn crawl_system_folders(self, input: bool) -> Self

TRUE to index shared files.

pub fn set_crawl_system_folders(self, input: Option<bool>) -> Self

TRUE to index shared files.

pub fn get_crawl_system_folders(&self) -> &Option<bool>

TRUE to index shared files.

pub fn crawl_comments(self, input: bool) -> Self

TRUE to index comments of blogs and other content.

pub fn set_crawl_comments(self, input: Option<bool>) -> Self

TRUE to index comments of blogs and other content.

pub fn get_crawl_comments(&self) -> &Option<bool>

TRUE to index comments of blogs and other content.

pub fn entity_filter(self, input: AlfrescoEntity) -> Self

Appends an item to entity_filter.

To override the contents of this collection use set_entity_filter.

Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

pub fn set_entity_filter(self, input: Option<Vec<AlfrescoEntity>>) -> Self

Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

pub fn get_entity_filter(&self) -> &Option<Vec<AlfrescoEntity>>

Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

pub fn document_library_field_mappings( self, input: DataSourceToIndexFieldMapping, ) -> Self

Appends an item to document_library_field_mappings.

To override the contents of this collection use set_document_library_field_mappings.

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn set_document_library_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn get_document_library_field_mappings( &self, ) -> &Option<Vec<DataSourceToIndexFieldMapping>>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn blog_field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self

Appends an item to blog_field_mappings.

To override the contents of this collection use set_blog_field_mappings.

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn set_blog_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn get_blog_field_mappings( &self, ) -> &Option<Vec<DataSourceToIndexFieldMapping>>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn wiki_field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self

Appends an item to wiki_field_mappings.

To override the contents of this collection use set_wiki_field_mappings.

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn set_wiki_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

pub fn get_wiki_field_mappings( &self, ) -> &Option<Vec<DataSourceToIndexFieldMapping>>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

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 regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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 regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

pub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

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

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

• site_url
• site_id
• secret_arn

Trait Implementations

impl Clone for AlfrescoConfigurationBuilder

fn clone(&self) -> AlfrescoConfigurationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlfrescoConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for AlfrescoConfigurationBuilder

fn default() -> AlfrescoConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for AlfrescoConfigurationBuilder

fn eq(&self, other: &AlfrescoConfigurationBuilder) -> 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 AlfrescoConfigurationBuilder