Class GetAbTestResponse

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

  • Method Details

    • abTestId

      public final String abTestId()

      The unique identifier of the A/B test.

      Returns:
      The unique identifier of the A/B test.

    • abTestArn

      public final String abTestArn()

      The Amazon Resource Name (ARN) of the A/B test.

      Returns:
      The Amazon Resource Name (ARN) of the A/B test.

    • name

      public final String name()

      The name of the A/B test.

      Returns:
      The name of the A/B test.

    • description

      public final String description()

      The description of the A/B test.

      Returns:
      The description of the A/B test.

    • status

      public final ABTestStatus status()

      The current status of the A/B test.

      If the service returns an enum value that is not available in the current SDK version, status will return ABTestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the A/B test.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the A/B test.

      If the service returns an enum value that is not available in the current SDK version, status will return ABTestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the A/B test.
      See Also:

    • executionStatus

      public final ABTestExecutionStatus executionStatus()

      The execution status indicating whether the A/B test is currently running.

      If the service returns an enum value that is not available in the current SDK version, executionStatus will return ABTestExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().

      Returns:
      The execution status indicating whether the A/B test is currently running.
      See Also:

    • executionStatusAsString

      public final String executionStatusAsString()

      The execution status indicating whether the A/B test is currently running.

      If the service returns an enum value that is not available in the current SDK version, executionStatus will return ABTestExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().

      Returns:
      The execution status indicating whether the A/B test is currently running.
      See Also:

    • gatewayArn

      public final String gatewayArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the gateway used 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 in the A/B test.

      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 in the A/B test.

    • gatewayFilter

      public final GatewayFilter gatewayFilter()

      The gateway filter restricting which target paths are included.

      Returns:
      The gateway filter restricting which target paths are included.

    • evaluationConfig

      public final ABTestEvaluationConfig evaluationConfig()

      The evaluation configuration for measuring variant performance.

      Returns:
      The evaluation configuration for measuring variant performance.

    • roleArn

      public final String roleArn()

      The IAM role ARN used by the A/B test.

      Returns:
      The IAM role ARN used by the A/B test.

    • currentRunId

      public final String currentRunId()

      The identifier of the current run of the A/B test.

      Returns:
      The identifier of the current run of the A/B test.

    • hasErrorDetails

      public final boolean hasErrorDetails()
      For responses, this returns true if the service returned a value for the ErrorDetails 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.

    • errorDetails

      public final List<String> errorDetails()

      The error details if the A/B test encountered failures.

      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 hasErrorDetails() method.

      Returns:
      The error details if the A/B test encountered failures.

    • startedAt

      public final Instant startedAt()

      The timestamp when the A/B test was started.

      Returns:
      The timestamp when the A/B test was started.

    • stoppedAt

      public final Instant stoppedAt()

      The timestamp when the A/B test was stopped.

      Returns:
      The timestamp when the A/B test was stopped.

    • maxDurationExpiresAt

      public final Instant maxDurationExpiresAt()

      The timestamp when the A/B test will automatically expire.

      Returns:
      The timestamp when the A/B test will automatically expire.

    • createdAt

      public final Instant createdAt()

      The timestamp when the A/B test was created.

      Returns:
      The timestamp when the A/B test was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the A/B test was last updated.

      Returns:
      The timestamp when the A/B test was last updated.

    • results

      public final ABTestResults results()

      The statistical results of the A/B test, including per-evaluator metrics and significance analysis.

      Returns:
      The statistical results of the A/B test, including per-evaluator metrics and significance analysis.

    • toBuilder

      public GetAbTestResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetAbTestResponse.Builder,GetAbTestResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetAbTestResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.