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

Interface CreateRetrieverRequest.Builder

    • Method Detail

      • applicationId

        CreateRetrieverRequest.Builder applicationId​(String applicationId)

        The identifier of your Amazon Q application.

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

      • clientToken

        CreateRetrieverRequest.Builder clientToken​(String clientToken)

        A token that you provide to identify the request to create your Amazon Q application retriever.

        Parameters:
        clientToken - A token that you provide to identify the request to create your Amazon Q application retriever.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configuration

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

      • displayName

        CreateRetrieverRequest.Builder displayName​(String displayName)

        The name of your retriever.

        Parameters:
        displayName - The name of your retriever.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        CreateRetrieverRequest.Builder roleArn​(String roleArn)

        The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

        Parameters:
        roleArn - The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

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

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

        CreateRetrieverRequest.Builder tags​(Tag... tags)

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

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

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