Interface CreateAbTestRequest.Builder

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

  • Method Details

    • name

      CreateAbTestRequest.Builder name(String name)

      The name of the A/B test. Must be unique within your account.

      Parameters:
      name - The name of the A/B test. Must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateAbTestRequest.Builder description(String description)

      The description of the A/B test.

      Parameters:
      description - The description of the A/B test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayArn

      CreateAbTestRequest.Builder gatewayArn(String gatewayArn)

      The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.

      Parameters:
      gatewayArn - The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variants

      CreateAbTestRequest.Builder variants(Collection<Variant> variants)

      The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.

      Parameters:
      variants - The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variants

      CreateAbTestRequest.Builder variants(Variant... variants)

      The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.

      Parameters:
      variants - The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variants

      CreateAbTestRequest.Builder variants(Consumer<Variant.Builder>... variants)

      The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to variants(List<Variant>).

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

    • gatewayFilter

      CreateAbTestRequest.Builder gatewayFilter(GatewayFilter gatewayFilter)

      Optional filter to restrict which gateway target paths are included in the A/B test.

      Parameters:
      gatewayFilter - Optional filter to restrict which gateway target paths are included in the A/B test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayFilter

      default CreateAbTestRequest.Builder gatewayFilter(Consumer<GatewayFilter.Builder> gatewayFilter)

      Optional filter to restrict which gateway target paths are included in the A/B test.

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

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

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

    • evaluationConfig

      CreateAbTestRequest.Builder evaluationConfig(ABTestEvaluationConfig evaluationConfig)

      The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.

      Parameters:
      evaluationConfig - The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationConfig

      default CreateAbTestRequest.Builder evaluationConfig(Consumer<ABTestEvaluationConfig.Builder> evaluationConfig)

      The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.

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

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

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

    • roleArn

      CreateAbTestRequest.Builder roleArn(String roleArn)

      The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.

      Parameters:
      roleArn - The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableOnCreate

      CreateAbTestRequest.Builder enableOnCreate(Boolean enableOnCreate)

      Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.

      Parameters:
      enableOnCreate - Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateAbTestRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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