Class EvaluateSessionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<EvaluateSessionResponse.Builder,
EvaluateSessionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationResult
Details resulting from the authentication process, such as authentication decision and authentication score.builder()
final String
domainId()
The identifier of the domain that contains the session.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FraudDetectionResult
Details resulting from the fraud detection process, such as fraud detection decision and risk score.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
static Class
<? extends EvaluateSessionResponse.Builder> final String
The service-generated identifier of the session.final String
The client-provided name of the session.final StreamingStatus
The current status of audio streaming for this session.final String
The current status of audio streaming for this session.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 class software.amazon.awssdk.services.voiceid.model.VoiceIdResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authenticationResult
Details resulting from the authentication process, such as authentication decision and authentication score.
- Returns:
- Details resulting from the authentication process, such as authentication decision and authentication score.
-
domainId
The identifier of the domain that contains the session.
- Returns:
- The identifier of the domain that contains the session.
-
fraudDetectionResult
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
- Returns:
- Details resulting from the fraud detection process, such as fraud detection decision and risk score.
-
sessionId
The service-generated identifier of the session.
- Returns:
- The service-generated identifier of the session.
-
sessionName
The client-provided name of the session.
- Returns:
- The client-provided name of the session.
-
streamingStatus
The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is
NOT_ENOUGH_SPEECH
. In this situation, if theStreamingStatus
isONGOING/PENDING_CONFIGURATION
, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remainsNOT_ENOUGH_SPEECH
even afterStreamingStatus
isENDED
, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.If the service returns an enum value that is not available in the current SDK version,
streamingStatus
will returnStreamingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamingStatusAsString()
.- Returns:
- The current status of audio streaming for this session. This field is useful to infer next steps when the
Authentication or Fraud Detection results are empty or the decision is
NOT_ENOUGH_SPEECH
. In this situation, if theStreamingStatus
isONGOING/PENDING_CONFIGURATION
, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remainsNOT_ENOUGH_SPEECH
even afterStreamingStatus
isENDED
, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again. - See Also:
-
streamingStatusAsString
The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is
NOT_ENOUGH_SPEECH
. In this situation, if theStreamingStatus
isONGOING/PENDING_CONFIGURATION
, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remainsNOT_ENOUGH_SPEECH
even afterStreamingStatus
isENDED
, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.If the service returns an enum value that is not available in the current SDK version,
streamingStatus
will returnStreamingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamingStatusAsString()
.- Returns:
- The current status of audio streaming for this session. This field is useful to infer next steps when the
Authentication or Fraud Detection results are empty or the decision is
NOT_ENOUGH_SPEECH
. In this situation, if theStreamingStatus
isONGOING/PENDING_CONFIGURATION
, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remainsNOT_ENOUGH_SPEECH
even afterStreamingStatus
isENDED
, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again. - See Also:
-
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<EvaluateSessionResponse.Builder,
EvaluateSessionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-