Package software.amazon.awssdk.services.qbusiness.model

Interface CreateDataSourceRequest.Builder

    • Method Detail

      • applicationId

        CreateDataSourceRequest.Builder applicationId​(String applicationId)

        The identifier of the Amazon Q application the data source will be attached to.

        Parameters:
        applicationId - The identifier of the Amazon Q application the data source will be attached to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateDataSourceRequest.Builder clientToken​(String clientToken)

        A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

        Parameters:
        clientToken - A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configuration

        CreateDataSourceRequest.Builder configuration​(Document configuration)

        Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

        Parameters:
        configuration - Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateDataSourceRequest.Builder description​(String description)

        A description for the data source connector.

        Parameters:
        description - A description for the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        CreateDataSourceRequest.Builder displayName​(String displayName)

        A name for the data source connector.

        Parameters:
        displayName - A name for the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentEnrichmentConfiguration

        CreateDataSourceRequest.Builder documentEnrichmentConfiguration​(DocumentEnrichmentConfiguration documentEnrichmentConfiguration)
        Sets the value of the DocumentEnrichmentConfiguration property for this object.
        Parameters:
        documentEnrichmentConfiguration - The new value for the DocumentEnrichmentConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • indexId

        CreateDataSourceRequest.Builder indexId​(String indexId)

        The identifier of the index that you want to use with the data source connector.

        Parameters:
        indexId - The identifier of the index that you want to use with the data source connector.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        CreateDataSourceRequest.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • syncSchedule

        CreateDataSourceRequest.Builder syncSchedule​(String syncSchedule)

        Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically update the index.

        Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

        Parameters:
        syncSchedule - Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically update the index.

        Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

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

      • tags

        CreateDataSourceRequest.Builder tags​(Collection<Tag> tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDataSourceRequest.Builder tags​(Tag... tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

        Parameters:
        tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDataSourceRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)