Package software.amazon.awssdk.services.kendra.model

Interface AlfrescoConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>, SdkBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>, SdkPojo
Enclosing class:
AlfrescoConfiguration
public static interface AlfrescoConfiguration.Builder extends SdkPojo, CopyableBuilder<AlfrescoConfiguration.Builder,AlfrescoConfiguration>

  • Method Details

    • siteUrl

      AlfrescoConfiguration.Builder siteUrl(String siteUrl)

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

      Parameters:
      siteUrl - The URL of the Alfresco site. For example, https://hostname:8080.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • siteId

      AlfrescoConfiguration.Builder siteId(String siteId)

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

      Parameters:
      siteId - The identifier of the Alfresco site. For example, my-site.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      AlfrescoConfiguration.Builder secretArn(String secretArn)

      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.

      Parameters:
      secretArn - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sslCertificateS3Path

      AlfrescoConfiguration.Builder sslCertificateS3Path(S3Path sslCertificateS3Path)

      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.

      Parameters:
      sslCertificateS3Path - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sslCertificateS3Path

      default AlfrescoConfiguration.Builder sslCertificateS3Path(Consumer<S3Path.Builder> sslCertificateS3Path)

      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 is a convenience method that creates an instance of the S3Path.Builder avoiding the need to create one manually via S3Path.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sslCertificateS3Path(S3Path).

      Parameters:
      sslCertificateS3Path - a consumer that will call methods on S3Path.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • crawlSystemFolders

      AlfrescoConfiguration.Builder crawlSystemFolders(Boolean crawlSystemFolders)

      TRUE to index shared files.

      Parameters:
      crawlSystemFolders - TRUE to index shared files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crawlComments

      AlfrescoConfiguration.Builder crawlComments(Boolean crawlComments)

      TRUE to index comments of blogs and other content.

      Parameters:
      crawlComments - TRUE to index comments of blogs and other content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityFilterWithStrings

      AlfrescoConfiguration.Builder entityFilterWithStrings(Collection<String> entityFilter)

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

      Parameters:
      entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityFilterWithStrings

      AlfrescoConfiguration.Builder entityFilterWithStrings(String... entityFilter)

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

      Parameters:
      entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityFilter

      AlfrescoConfiguration.Builder entityFilter(Collection<AlfrescoEntity> entityFilter)

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

      Parameters:
      entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityFilter

      AlfrescoConfiguration.Builder entityFilter(AlfrescoEntity... entityFilter)

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

      Parameters:
      entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentLibraryFieldMappings

      AlfrescoConfiguration.Builder documentLibraryFieldMappings(Collection<DataSourceToIndexFieldMapping> documentLibraryFieldMappings)

      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.

      Parameters:
      documentLibraryFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentLibraryFieldMappings

      AlfrescoConfiguration.Builder documentLibraryFieldMappings(DataSourceToIndexFieldMapping... documentLibraryFieldMappings)

      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.

      Parameters:
      documentLibraryFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentLibraryFieldMappings

      AlfrescoConfiguration.Builder documentLibraryFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... documentLibraryFieldMappings)

      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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentLibraryFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      documentLibraryFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blogFieldMappings

      AlfrescoConfiguration.Builder blogFieldMappings(Collection<DataSourceToIndexFieldMapping> blogFieldMappings)

      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.

      Parameters:
      blogFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blogFieldMappings

      AlfrescoConfiguration.Builder blogFieldMappings(DataSourceToIndexFieldMapping... blogFieldMappings)

      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.

      Parameters:
      blogFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blogFieldMappings

      AlfrescoConfiguration.Builder blogFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... blogFieldMappings)

      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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blogFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      blogFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • wikiFieldMappings

      AlfrescoConfiguration.Builder wikiFieldMappings(Collection<DataSourceToIndexFieldMapping> wikiFieldMappings)

      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.

      Parameters:
      wikiFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wikiFieldMappings

      AlfrescoConfiguration.Builder wikiFieldMappings(DataSourceToIndexFieldMapping... wikiFieldMappings)

      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.

      Parameters:
      wikiFieldMappings - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wikiFieldMappings

      AlfrescoConfiguration.Builder wikiFieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... wikiFieldMappings)

      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.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wikiFieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      wikiFieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inclusionPatterns

      AlfrescoConfiguration.Builder inclusionPatterns(Collection<String> inclusionPatterns)

      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.

      Parameters:
      inclusionPatterns - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      AlfrescoConfiguration.Builder inclusionPatterns(String... inclusionPatterns)

      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.

      Parameters:
      inclusionPatterns - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      AlfrescoConfiguration.Builder exclusionPatterns(Collection<String> exclusionPatterns)

      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.

      Parameters:
      exclusionPatterns - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      AlfrescoConfiguration.Builder exclusionPatterns(String... exclusionPatterns)

      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.

      Parameters:
      exclusionPatterns - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      AlfrescoConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)

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

      Parameters:
      vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfiguration

      default AlfrescoConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)

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

      This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).

      Parameters:
      vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: