Class EvaluateSessionResponse

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

  • Method Details

    • authenticationResult

      public final AuthenticationResult authenticationResult()

      Details resulting from the authentication process, such as authentication decision and authentication score.

      Returns:
      Details resulting from the authentication process, such as authentication decision and authentication score.

    • domainId

      public final String domainId()

      The identifier of the domain that contains the session.

      Returns:
      The identifier of the domain that contains the session.

    • fraudDetectionResult

      public final FraudDetectionResult fraudDetectionResult()

      Details resulting from the fraud detection process, such as fraud detection decision and risk score.

      Returns:
      Details resulting from the fraud detection process, such as fraud detection decision and risk score.

    • sessionId

      public final String sessionId()

      The service-generated identifier of the session.

      Returns:
      The service-generated identifier of the session.

    • sessionName

      public final String sessionName()

      The client-provided name of the session.

      Returns:
      The client-provided name of the session.

    • streamingStatus

      public final StreamingStatus streamingStatus()

      The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

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

      Returns:
      The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
      See Also:

    • streamingStatusAsString

      public final String streamingStatusAsString()

      The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

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

      Returns:
      The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
      See Also:

    • toBuilder

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

    • builder

      public static EvaluateSessionResponse.Builder builder()

    • serializableBuilderClass

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