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

Interface CreateIndexRequest.Builder

    • Method Detail

      • applicationId

        CreateIndexRequest.Builder applicationId​(String applicationId)

        The identifier of the Amazon Q application using the index.

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

      • capacityConfiguration

        CreateIndexRequest.Builder capacityConfiguration​(IndexCapacityConfiguration capacityConfiguration)

        The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

        Parameters:
        capacityConfiguration - The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateIndexRequest.Builder clientToken​(String clientToken)

        A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

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

      • description

        CreateIndexRequest.Builder description​(String description)

        A description for the Amazon Q index.

        Parameters:
        description - A description for the Amazon Q index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        CreateIndexRequest.Builder displayName​(String displayName)

        A name for the Amazon Q index.

        Parameters:
        displayName - A name for the Amazon Q index.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

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

        A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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 index. You can also use tags to help control access to the index. 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

        CreateIndexRequest.Builder tags​(Tag... tags)

        A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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 index. You can also use tags to help control access to the index. 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

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

        A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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)