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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AuthenticationResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Instant`	`audioAggregationEndedAt()`	A timestamp of when audio aggregation ended for this authentication result.
`Instant`	`audioAggregationStartedAt()`	A timestamp of when audio aggregation started for this authentication result.
`String`	`authenticationResultId()`	The unique identifier for this authentication result.
`static AuthenticationResult.Builder`	`builder()`
`AuthenticationConfiguration`	`configuration()`	The `AuthenticationConfiguration` used to generate this authentication result.
`String`	`customerSpeakerId()`	The client-provided identifier for the speaker whose authentication result is produced.
`AuthenticationDecision`	`decision()`	The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`String`	`decisionAsString()`	The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`generatedSpeakerId()`	The service-generated identifier for the speaker whose authentication result is produced.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`score()`	The authentication score for the speaker whose authentication result is produced.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AuthenticationResult.Builder>`	`serializableBuilderClass()`
`AuthenticationResult.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AuthenticationDecision
  - 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:
    
    AuthenticationDecision
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AuthenticationResult.Builder,AuthenticationResult>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AuthenticationResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

audioAggregationEndedAt

audioAggregationStartedAt

authenticationResultId

configuration

customerSpeakerId

decision

decisionAsString

generatedSpeakerId

score

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields