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

Interface SharePointConfiguration.Builder

    • Method Detail

      • sharePointVersion

        SharePointConfiguration.Builder sharePointVersion​(String sharePointVersion)

        The version of Microsoft SharePoint that you use.

        Parameters:
        sharePointVersion - The version of Microsoft SharePoint that you use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SharePointVersion, SharePointVersion

      • urls

        SharePointConfiguration.Builder urls​(Collection<String> urls)

        The Microsoft SharePoint site URLs for the documents you want to index.

        Parameters:
        urls - The Microsoft SharePoint site URLs for the documents you want to index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • urls

        SharePointConfiguration.Builder urls​(String... urls)

        The Microsoft SharePoint site URLs for the documents you want to index.

        Parameters:
        urls - The Microsoft SharePoint site URLs for the documents you want to index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secretArn

        SharePointConfiguration.Builder secretArn​(String secretArn)

        The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

        Parameters:
        secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • crawlAttachments

        SharePointConfiguration.Builder crawlAttachments​(Boolean crawlAttachments)

        TRUE to index document attachments.

        Parameters:
        crawlAttachments - TRUE to index document attachments.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • useChangeLog

        SharePointConfiguration.Builder useChangeLog​(Boolean useChangeLog)

        TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

        Parameters:
        useChangeLog - TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inclusionPatterns

        SharePointConfiguration.Builder inclusionPatterns​(Collection<String> inclusionPatterns)

        A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

        Parameters:
        inclusionPatterns - A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

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

      • inclusionPatterns

        SharePointConfiguration.Builder inclusionPatterns​(String... inclusionPatterns)

        A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

        Parameters:
        inclusionPatterns - A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

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

      • exclusionPatterns

        SharePointConfiguration.Builder exclusionPatterns​(Collection<String> exclusionPatterns)

        A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

        Parameters:
        exclusionPatterns - A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

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

      • exclusionPatterns

        SharePointConfiguration.Builder exclusionPatterns​(String... exclusionPatterns)

        A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

        Parameters:
        exclusionPatterns - A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

        The regex applies to the display URL of the SharePoint document.

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

      • vpcConfiguration

        SharePointConfiguration.Builder vpcConfiguration​(DataSourceVpcConfiguration vpcConfiguration)

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

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

      • fieldMappings

        SharePointConfiguration.Builder fieldMappings​(Collection<DataSourceToIndexFieldMapping> fieldMappings)

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

        Parameters:
        fieldMappings - A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fieldMappings

        SharePointConfiguration.Builder fieldMappings​(DataSourceToIndexFieldMapping... fieldMappings)

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

        Parameters:
        fieldMappings - A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentTitleFieldName

        SharePointConfiguration.Builder documentTitleFieldName​(String documentTitleFieldName)

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

        Parameters:
        documentTitleFieldName - The Microsoft SharePoint attribute field that contains the title of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • disableLocalGroups

        SharePointConfiguration.Builder disableLocalGroups​(Boolean disableLocalGroups)

        TRUE to disable local groups information.

        Parameters:
        disableLocalGroups - TRUE to disable local groups information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslCertificateS3Path

        SharePointConfiguration.Builder sslCertificateS3Path​(S3Path sslCertificateS3Path)

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

        You can 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 SharePoint Server if you require a secure SSL connection.

        You can 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.

      • authenticationType

        SharePointConfiguration.Builder authenticationType​(String authenticationType)

        Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

        Parameters:
        authenticationType - Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SharePointOnlineAuthenticationType, SharePointOnlineAuthenticationType

      • authenticationType

        SharePointConfiguration.Builder authenticationType​(SharePointOnlineAuthenticationType authenticationType)

        Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

        Parameters:
        authenticationType - Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SharePointOnlineAuthenticationType, SharePointOnlineAuthenticationType

      • proxyConfiguration

        SharePointConfiguration.Builder proxyConfiguration​(ProxyConfiguration proxyConfiguration)

        Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

        You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

        Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

        It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

        Parameters:
        proxyConfiguration - Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

        You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

        Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

        It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

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

      • proxyConfiguration

        default SharePointConfiguration.Builder proxyConfiguration​(Consumer<ProxyConfiguration.Builder> proxyConfiguration)

        Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

        You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

        Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

        It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

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

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

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