Interface CreateRetrieverRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateRetrieverRequest.Builder,CreateRetrieverRequest>, QBusinessRequest.Builder, SdkBuilder<CreateRetrieverRequest.Builder,CreateRetrieverRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateRetrieverRequest
@Mutable @NotThreadSafe public static interface CreateRetrieverRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateRetrieverRequest.Builder,CreateRetrieverRequest>

  • Method Details

    • applicationId

      CreateRetrieverRequest.Builder applicationId(String applicationId)

      The identifier of your Amazon Q Business application.

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

    • type

      CreateRetrieverRequest.Builder type(String type)

      The type of retriever you are using.

      Parameters:
      type - The type of retriever you are using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateRetrieverRequest.Builder type(RetrieverType type)

      The type of retriever you are using.

      Parameters:
      type - The type of retriever you are using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • 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.

    • configuration

      default CreateRetrieverRequest.Builder configuration(Consumer<RetrieverConfiguration.Builder> configuration)
      Sets the value of the Configuration property for this object. This is a convenience method that creates an instance of the RetrieverConfiguration.Builder avoiding the need to create one manually via RetrieverConfiguration.builder().

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

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

    • roleArn

      CreateRetrieverRequest.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The ARN of an IAM role used by Amazon Q Business 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.

    • clientToken

      CreateRetrieverRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A token that you provide to identify the request to create your Amazon Q Business application retriever.
      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<Tag>).

      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:

    • overrideConfiguration

      CreateRetrieverRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateRetrieverRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.