Package software.amazon.awssdk.services.kendraranking.model

Interface CreateRescoreExecutionPlanRequest.Builder

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

  • Method Details

    • name

      CreateRescoreExecutionPlanRequest.Builder name(String name)

      A name for the rescore execution plan.

      Parameters:
      name - A name for the rescore execution plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateRescoreExecutionPlanRequest.Builder description(String description)

      A description for the rescore execution plan.

      Parameters:
      description - A description for the rescore execution plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityUnits

      CreateRescoreExecutionPlanRequest.Builder capacityUnits(CapacityUnitsConfiguration capacityUnits)

      You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.

      Parameters:
      capacityUnits - You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityUnits

      default CreateRescoreExecutionPlanRequest.Builder capacityUnits(Consumer<CapacityUnitsConfiguration.Builder> capacityUnits)

      You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.

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

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

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

    • tags

      CreateRescoreExecutionPlanRequest.Builder tags(Collection<Tag> tags)

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

      CreateRescoreExecutionPlanRequest.Builder tags(Tag... tags)

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

      CreateRescoreExecutionPlanRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

    • clientToken

      CreateRescoreExecutionPlanRequest.Builder clientToken(String clientToken)

      A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the CreateRescoreExecutionPlanRequest API with the same client token will create only one rescore execution plan.

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

    • overrideConfiguration

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

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