AuthenticationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.voiceid.model.AuthenticationResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticationResult
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthenticationResult()

Constructors
Constructor and Description
`AuthenticationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getAudioAggregationEndedAt()` A timestamp of when audio aggregation ended for this authentication result.
`Date`	`getAudioAggregationStartedAt()` A timestamp of when audio aggregation started for this authentication result.
`String`	`getAuthenticationResultId()` The unique identifier for this authentication result.
`AuthenticationConfiguration`	`getConfiguration()` The `AuthenticationConfiguration` used to generate this authentication result.
`String`	`getCustomerSpeakerId()` The client-provided identifier for the speaker whose authentication result is produced.
`String`	`getDecision()` The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`String`	`getGeneratedSpeakerId()` The service-generated identifier for the speaker whose authentication result is produced.
`Integer`	`getScore()` The authentication score for the speaker whose authentication result is produced.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAudioAggregationEndedAt(Date audioAggregationEndedAt)` A timestamp of when audio aggregation ended for this authentication result.
`void`	`setAudioAggregationStartedAt(Date audioAggregationStartedAt)` A timestamp of when audio aggregation started for this authentication result.
`void`	`setAuthenticationResultId(String authenticationResultId)` The unique identifier for this authentication result.
`void`	`setConfiguration(AuthenticationConfiguration configuration)` The `AuthenticationConfiguration` used to generate this authentication result.
`void`	`setCustomerSpeakerId(String customerSpeakerId)` The client-provided identifier for the speaker whose authentication result is produced.
`void`	`setDecision(String decision)` The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`void`	`setGeneratedSpeakerId(String generatedSpeakerId)` The service-generated identifier for the speaker whose authentication result is produced.
`void`	`setScore(Integer score)` The authentication score for the speaker whose authentication result is produced.
`String`	`toString()` Returns a string representation of this object.
`AuthenticationResult`	`withAudioAggregationEndedAt(Date audioAggregationEndedAt)` A timestamp of when audio aggregation ended for this authentication result.
`AuthenticationResult`	`withAudioAggregationStartedAt(Date audioAggregationStartedAt)` A timestamp of when audio aggregation started for this authentication result.
`AuthenticationResult`	`withAuthenticationResultId(String authenticationResultId)` The unique identifier for this authentication result.
`AuthenticationResult`	`withConfiguration(AuthenticationConfiguration configuration)` The `AuthenticationConfiguration` used to generate this authentication result.
`AuthenticationResult`	`withCustomerSpeakerId(String customerSpeakerId)` The client-provided identifier for the speaker whose authentication result is produced.
`AuthenticationResult`	`withDecision(AuthenticationDecision decision)` The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`AuthenticationResult`	`withDecision(String decision)` The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
`AuthenticationResult`	`withGeneratedSpeakerId(String generatedSpeakerId)` The service-generated identifier for the speaker whose authentication result is produced.
`AuthenticationResult`	`withScore(Integer score)` The authentication score for the speaker whose authentication result is produced.

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

- Constructor Detail
  - AuthenticationResult
```
public AuthenticationResult()
```
- Method Detail
  - setAudioAggregationEndedAt
```
public void setAudioAggregationEndedAt(Date 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.
  - getAudioAggregationEndedAt
```
public Date getAudioAggregationEndedAt()
```
    A timestamp of when audio aggregation ended for this authentication result.
    
    Returns:
    
    A timestamp of when audio aggregation ended for this authentication result.
  - withAudioAggregationEndedAt
```
public AuthenticationResult withAudioAggregationEndedAt(Date 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.
  - setAudioAggregationStartedAt
```
public void setAudioAggregationStartedAt(Date 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.
  - getAudioAggregationStartedAt
```
public Date getAudioAggregationStartedAt()
```
    A timestamp of when audio aggregation started for this authentication result.
    
    Returns:
    
    A timestamp of when audio aggregation started for this authentication result.
  - withAudioAggregationStartedAt
```
public AuthenticationResult withAudioAggregationStartedAt(Date 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.
  - setAuthenticationResultId
```
public void setAuthenticationResultId(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.
  - getAuthenticationResultId
```
public String getAuthenticationResultId()
```
    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.
  - withAuthenticationResultId
```
public AuthenticationResult withAuthenticationResultId(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.
  - setConfiguration
```
public void setConfiguration(AuthenticationConfiguration configuration)
```
    The AuthenticationConfiguration used to generate this authentication result.
    
    Parameters:
    
    configuration - The AuthenticationConfiguration used to generate this authentication result.
  - getConfiguration
```
public AuthenticationConfiguration getConfiguration()
```
    The AuthenticationConfiguration used to generate this authentication result.
    
    Returns:
    
    The AuthenticationConfiguration used to generate this authentication result.
  - withConfiguration
```
public AuthenticationResult withConfiguration(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.
  - setCustomerSpeakerId
```
public void setCustomerSpeakerId(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.
  - getCustomerSpeakerId
```
public String getCustomerSpeakerId()
```
    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.
  - withCustomerSpeakerId
```
public AuthenticationResult withCustomerSpeakerId(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.
  - setDecision
```
public void setDecision(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.
    
    See Also:
    
    AuthenticationDecision
  - getDecision
```
public String getDecision()
```
    The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
    
    Returns:
    
    The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
    
    See Also:
    
    AuthenticationDecision
  - withDecision
```
public AuthenticationResult withDecision(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
  - withDecision
```
public AuthenticationResult withDecision(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
  - setGeneratedSpeakerId
```
public void setGeneratedSpeakerId(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.
  - getGeneratedSpeakerId
```
public String getGeneratedSpeakerId()
```
    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.
  - withGeneratedSpeakerId
```
public AuthenticationResult withGeneratedSpeakerId(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.
  - setScore
```
public void setScore(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.
  - getScore
```
public Integer getScore()
```
    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.
  - withScore
```
public AuthenticationResult withScore(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AuthenticationResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class AuthenticationResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthenticationResult

Method Detail

setAudioAggregationEndedAt

getAudioAggregationEndedAt

withAudioAggregationEndedAt

setAudioAggregationStartedAt

getAudioAggregationStartedAt

withAudioAggregationStartedAt

setAuthenticationResultId

getAuthenticationResultId

withAuthenticationResultId

setConfiguration

getConfiguration

withConfiguration

setCustomerSpeakerId

getCustomerSpeakerId

withCustomerSpeakerId

setDecision

getDecision

withDecision

withDecision

setGeneratedSpeakerId

getGeneratedSpeakerId

withGeneratedSpeakerId

setScore

getScore

withScore

toString

equals

hashCode

clone

marshall