Class VoiceProfileCancellationDetails
- java.lang.Object
-
- com.microsoft.cognitiveservices.speech.speaker.VoiceProfileCancellationDetails
-
public class VoiceProfileCancellationDetails extends Object
Contains detailed information about why a voice profile creation was canceled.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Explicitly frees any external resource attached to the objectstatic VoiceProfileCancellationDetailsfromResult(VoiceProfileResult result)Creates an instance of VoiceProfileCancellationDetails object for the canceled VoiceProfileResult.CancellationErrorCodegetErrorCode()The error code in case of an unsuccessful voice profile creation (when getReason() returns Error).StringgetErrorDetails()The error message in case of an unsuccessful voice profile creation (when getReason() returns Error).CancellationReasongetReason()The reason the voice profile creation was canceled.StringtoString()Returns a String that represents the cancellation details.
-
-
-
Method Detail
-
fromResult
public static VoiceProfileCancellationDetails fromResult(VoiceProfileResult result)
Creates an instance of VoiceProfileCancellationDetails object for the canceled VoiceProfileResult.- Parameters:
result- The voice profile result that was canceled.- Returns:
- The cancellation details object being created.
-
close
public void close()
Explicitly frees any external resource attached to the object
-
getReason
public CancellationReason getReason()
The reason the voice profile creation was canceled.- Returns:
- Specifies the reason canceled.
-
getErrorCode
public CancellationErrorCode getErrorCode()
The error code in case of an unsuccessful voice profile creation (when getReason() returns Error).- Returns:
- An error code that represents the error reason.
-
getErrorDetails
public String getErrorDetails()
The error message in case of an unsuccessful voice profile creation (when getReason() returns Error).- Returns:
- A String that represents the error details.
-
-