Package software.amazon.awssdk.services.lexmodelsv2.model

Class DescribeTestExecutionResponse

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

  • Method Details

    • testExecutionId

      public final String testExecutionId()

      The execution Id for the test set execution.

      Returns:
      The execution Id for the test set execution.

    • creationDateTime

      public final Instant creationDateTime()

      The execution creation date and time for the test set execution.

      Returns:
      The execution creation date and time for the test set execution.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time of the last update for the execution.

      Returns:
      The date and time of the last update for the execution.

    • testExecutionStatus

      public final TestExecutionStatus testExecutionStatus()

      The test execution status for the test execution.

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

      Returns:
      The test execution status for the test execution.
      See Also:

    • testExecutionStatusAsString

      public final String testExecutionStatusAsString()

      The test execution status for the test execution.

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

      Returns:
      The test execution status for the test execution.
      See Also:

    • testSetId

      public final String testSetId()

      The test set Id for the test set execution.

      Returns:
      The test set Id for the test set execution.

    • testSetName

      public final String testSetName()

      The test set name of the test set execution.

      Returns:
      The test set name of the test set execution.

    • target

      public final TestExecutionTarget target()

      The target bot for the test set execution details.

      Returns:
      The target bot for the test set execution details.

    • apiMode

      public final TestExecutionApiMode apiMode()

      Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.

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

      Returns:
      Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.
      See Also:

    • apiModeAsString

      public final String apiModeAsString()

      Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.

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

      Returns:
      Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.
      See Also:

    • testExecutionModality

      public final TestExecutionModality testExecutionModality()

      Indicates whether test set is audio or text.

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

      Returns:
      Indicates whether test set is audio or text.
      See Also:

    • testExecutionModalityAsString

      public final String testExecutionModalityAsString()

      Indicates whether test set is audio or text.

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

      Returns:
      Indicates whether test set is audio or text.
      See Also:

    • hasFailureReasons

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

    • failureReasons

      public final List<String> failureReasons()

      Reasons for the failure of the test set execution.

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

      Returns:
      Reasons for the failure of the test set execution.

    • toBuilder

      public DescribeTestExecutionResponse.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<DescribeTestExecutionResponse.Builder,DescribeTestExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeTestExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeTestExecutionResponse.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.