Interface CreateIndexRequest.Builder

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

  • Method Details

    • applicationId

      CreateIndexRequest.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application using the index.

      Parameters:
      applicationId - The identifier of the Amazon Q Business application using the 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 Business index.

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

    • type

      CreateIndexRequest.Builder type(String type)

      The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

      Parameters:
      type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateIndexRequest.Builder type(IndexType type)

      The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

      Parameters:
      type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateIndexRequest.Builder description(String description)

      A description for the Amazon Q Business index.

      Parameters:
      description - A description for the Amazon Q Business 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<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:

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

    • capacityConfiguration

      default CreateIndexRequest.Builder capacityConfiguration(Consumer<IndexCapacityConfiguration.Builder> capacityConfiguration)

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

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

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

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

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

    • overrideConfiguration

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

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