software.amazon.awssdk.services.voiceid.model

Interface AuthenticationResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AuthenticationResult.Builder,AuthenticationResult>, SdkBuilder<AuthenticationResult.Builder,AuthenticationResult>, SdkPojo

Enclosing class:

AuthenticationResult

public static interface AuthenticationResult.Builder
extends SdkPojo, CopyableBuilder<AuthenticationResult.Builder,AuthenticationResult>

Method Summary

Modifier and Type	Method and Description
AuthenticationResult.Builder	audioAggregationEndedAt(Instant audioAggregationEndedAt) A timestamp indicating when audio aggregation ended for this authentication result.
AuthenticationResult.Builder	audioAggregationStartedAt(Instant audioAggregationStartedAt) A timestamp indicating when audio aggregation started for this authentication result.
AuthenticationResult.Builder	authenticationResultId(String authenticationResultId) The unique identifier for this authentication result.
AuthenticationResult.Builder	configuration(AuthenticationConfiguration configuration) The AuthenticationConfiguration used to generate this authentication result.
default AuthenticationResult.Builder	configuration(Consumer<AuthenticationConfiguration.Builder> configuration) The AuthenticationConfiguration used to generate this authentication result.
AuthenticationResult.Builder	customerSpeakerId(String customerSpeakerId) The client-provided identifier for the speaker whose authentication result is produced.
AuthenticationResult.Builder	decision(AuthenticationDecision decision) The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
AuthenticationResult.Builder	decision(String decision) The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
AuthenticationResult.Builder	generatedSpeakerId(String generatedSpeakerId) The service-generated identifier for the speaker whose authentication result is produced.
AuthenticationResult.Builder	score(Integer score) The authentication score for the speaker whose authentication result is produced.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

audioAggregationEndedAt

AuthenticationResult.Builder audioAggregationEndedAt(Instant audioAggregationEndedAt)

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

Parameters:

audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this authentication result.

Returns:

Returns a reference to this object so that method calls can be chained together.

audioAggregationStartedAt

AuthenticationResult.Builder audioAggregationStartedAt(Instant audioAggregationStartedAt)

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

Parameters:

audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this authentication result.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationResultId

AuthenticationResult.Builder authenticationResultId(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.

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, or SpeakerId 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

AuthenticationResult.Builder configuration(AuthenticationConfiguration configuration)

The AuthenticationConfiguration used to generate this authentication result.

Parameters:

configuration - The AuthenticationConfiguration 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 AuthenticationConfiguration used to generate this authentication result.

This is a convenience method that creates an instance of the AuthenticationConfiguration.Builder avoiding the need to create one manually via AuthenticationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(AuthenticationConfiguration).

Parameters:

configuration - a consumer that will call methods on AuthenticationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

configuration(AuthenticationConfiguration)

customerSpeakerId

AuthenticationResult.Builder customerSpeakerId(String 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 a SpeakerId is provided for the session.

Returns:

Returns a reference to this object so that method calls can be chained together.

decision

AuthenticationResult.Builder decision(String 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:

AuthenticationDecision, AuthenticationDecision

decision

AuthenticationResult.Builder decision(AuthenticationDecision 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:

AuthenticationDecision, AuthenticationDecision

generatedSpeakerId

AuthenticationResult.Builder generatedSpeakerId(String 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

AuthenticationResult.Builder score(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.