Class StartTestExecutionRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartTestExecutionRequest.Builder,StartTestExecutionRequest>

@Generated("software.amazon.awssdk:codegen") public final class StartTestExecutionRequest extends LexModelsV2Request implements ToCopyableBuilder<StartTestExecutionRequest.Builder,StartTestExecutionRequest>
  • Method Details

    • testSetId

      public final String testSetId()

      The test set Id for the test set execution.

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

      public final TestExecutionTarget target()

      The target bot for the test set execution.

      Returns:
      The target bot for the test set execution.
    • apiMode

      public final TestExecutionApiMode apiMode()

      Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are 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 for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
      See Also:
    • apiModeAsString

      public final String apiModeAsString()

      Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are 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 for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
      See Also:
    • testExecutionModality

      public final TestExecutionModality testExecutionModality()

      Indicates whether audio or text is used.

      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 audio or text is used.
      See Also:
    • testExecutionModalityAsString

      public final String testExecutionModalityAsString()

      Indicates whether audio or text is used.

      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 audio or text is used.
      See Also:
    • 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<StartTestExecutionRequest.Builder,StartTestExecutionRequest>
      Specified by:
      toBuilder in class LexModelsV2Request
      Returns:
      a builder for type T
    • builder

      public static StartTestExecutionRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends StartTestExecutionRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.