Interface AuthenticationResult.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AuthenticationResult.Builder,
,AuthenticationResult> SdkBuilder<AuthenticationResult.Builder,
,AuthenticationResult> SdkPojo
- Enclosing class:
AuthenticationResult
-
Method Summary
Modifier and TypeMethodDescriptionaudioAggregationEndedAt
(Instant audioAggregationEndedAt) A timestamp of when audio aggregation ended for this authentication result.audioAggregationStartedAt
(Instant audioAggregationStartedAt) A timestamp of when audio aggregation started for this authentication result.authenticationResultId
(String authenticationResultId) The unique identifier for this authentication result.default AuthenticationResult.Builder
configuration
(Consumer<AuthenticationConfiguration.Builder> configuration) TheAuthenticationConfiguration
used to generate this authentication result.configuration
(AuthenticationConfiguration configuration) TheAuthenticationConfiguration
used to generate this authentication result.customerSpeakerId
(String customerSpeakerId) The client-provided identifier for the speaker whose authentication result is produced.The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.decision
(AuthenticationDecision decision) The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.generatedSpeakerId
(String generatedSpeakerId) The service-generated identifier for the speaker whose authentication result is produced.The authentication score for the speaker whose authentication result is produced.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
audioAggregationEndedAt
A timestamp of when audio aggregation ended for this authentication result.
- Parameters:
audioAggregationEndedAt
- A timestamp of when audio aggregation ended for this authentication result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
audioAggregationStartedAt
A timestamp of when audio aggregation started for this authentication result.
- Parameters:
audioAggregationStartedAt
- A timestamp of when audio aggregation started for this authentication result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
The
AuthenticationConfiguration
used to generate this authentication result.- Parameters:
configuration
- TheAuthenticationConfiguration
used to generate this authentication result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
default AuthenticationResult.Builder configuration(Consumer<AuthenticationConfiguration.Builder> configuration) The
This is a convenience method that creates an instance of theAuthenticationConfiguration
used to generate this authentication result.AuthenticationConfiguration.Builder
avoiding the need to create one manually viaAuthenticationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfiguration(AuthenticationConfiguration)
.- Parameters:
configuration
- a consumer that will call methods onAuthenticationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
customerSpeakerId
The client-provided identifier for the speaker whose authentication result is produced. Only present if a
SpeakerId
is provided for the session.- Parameters:
customerSpeakerId
- The client-provided identifier for the speaker whose authentication result is produced. Only present if aSpeakerId
is provided for the session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
decision
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
- Parameters:
decision
- The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
decision
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
- Parameters:
decision
- The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
generatedSpeakerId
The service-generated identifier for the speaker whose authentication result is produced.
- Parameters:
generatedSpeakerId
- The service-generated identifier for the speaker whose authentication result is produced.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
score
- The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is eitherACCEPT
orREJECT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-