Package software.amazon.awssdk.services.bedrockagentcore.model

Class CreateAbTestRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.CreateAbTestRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAbTestRequest.Builder,CreateAbTestRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAbTestRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<CreateAbTestRequest.Builder,CreateAbTestRequest>

  • Method Details

    • name

      public final String name()

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

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

    • description

      public final String description()

      The description of the A/B test.

      Returns:
      The description of the A/B test.

    • gatewayArn

      public final String gatewayArn()

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

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

    • hasVariants

      public final boolean hasVariants()
      For responses, this returns true if the service returned a value for the Variants property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • variants

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariants() method.

      Returns:
      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.

    • gatewayFilter

      public final GatewayFilter gatewayFilter()

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

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

    • evaluationConfig

      public final ABTestEvaluationConfig evaluationConfig()

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

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

    • roleArn

      public final String roleArn()

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

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

    • enableOnCreate

      public final Boolean enableOnCreate()

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

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

    • clientToken

      public final 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.

      Returns:
      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.

    • toBuilder

      public CreateAbTestRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAbTestRequest.Builder,CreateAbTestRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static CreateAbTestRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAbTestRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo