Class AuthenticationResult

java.lang.Object
software.amazon.awssdk.services.voiceid.model.AuthenticationResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AuthenticationResult.Builder,AuthenticationResult>
@Generated("software.amazon.awssdk:codegen") public final class AuthenticationResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthenticationResult.Builder,AuthenticationResult>

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

See Also:

  • Method Details

    • audioAggregationEndedAt

      public final Instant audioAggregationEndedAt()

      A timestamp of when audio aggregation ended for this authentication result.

      Returns:
      A timestamp of when audio aggregation ended for this authentication result.

    • audioAggregationStartedAt

      public final Instant audioAggregationStartedAt()

      A timestamp of when audio aggregation started for this authentication result.

      Returns:
      A timestamp of when audio aggregation started for this authentication result.

    • authenticationResultId

      public final String authenticationResultId()

      The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

      Returns:
      The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

    • configuration

      public final AuthenticationConfiguration configuration()

      The AuthenticationConfiguration used to generate this authentication result.

      Returns:
      The AuthenticationConfiguration used to generate this authentication result.

    • customerSpeakerId

      public final String customerSpeakerId()

      The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

      Returns:
      The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

    • decision

      public final AuthenticationDecision decision()

      The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

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

      Returns:
      The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
      See Also:

    • decisionAsString

      public final String decisionAsString()

      The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

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

      Returns:
      The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
      See Also:

    • generatedSpeakerId

      public final String generatedSpeakerId()

      The service-generated identifier for the speaker whose authentication result is produced.

      Returns:
      The service-generated identifier for the speaker whose authentication result is produced.

    • score

      public final Integer score()

      The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.

      Returns:
      The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.

    • toBuilder

      public AuthenticationResult.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<AuthenticationResult.Builder,AuthenticationResult>
      Returns:
      a builder for type T

    • builder

      public static AuthenticationResult.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.