Class AuthenticationResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
A timestamp of when audio aggregation ended for this authentication result.final Instant
A timestamp of when audio aggregation started for this authentication result.final String
The unique identifier for this authentication result.static AuthenticationResult.Builder
builder()
TheAuthenticationConfiguration
used to generate this authentication result.final String
The client-provided identifier for the speaker whose authentication result is produced.final AuthenticationDecision
decision()
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.final String
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The service-generated identifier for the speaker whose authentication result is produced.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
score()
The authentication score for the speaker whose authentication result is produced.static Class
<? extends AuthenticationResult.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
A timestamp of when audio aggregation started for this authentication result.
- Returns:
- A timestamp of when audio aggregation started for this authentication result.
-
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, orSpeakerId
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, orSpeakerId
changes, Voice ID always returns cached Authentication Result for this API.
-
configuration
The
AuthenticationConfiguration
used to generate this authentication result.- Returns:
- The
AuthenticationConfiguration
used to generate this authentication result.
-
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
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 returnAuthenticationDecision.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdecisionAsString()
.- Returns:
- The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
- See Also:
-
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 returnAuthenticationDecision.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdecisionAsString()
.- Returns:
- The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
- See Also:
-
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
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either
ACCEPT
orREJECT
.- Returns:
- The authentication score for the speaker whose authentication result is produced. This value is only
present if the authentication decision is either
ACCEPT
orREJECT
.
-
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 interfaceToCopyableBuilder<AuthenticationResult.Builder,
AuthenticationResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-