Package com.azure.ai.textanalytics.models

Class TextAnalyticsError

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsError

All Implemented Interfaces:

com.azure.json.JsonSerializable<TextAnalyticsError>

public final class TextAnalyticsError
extends Object
implements com.azure.json.JsonSerializable<TextAnalyticsError>

The TextAnalyticsError model.

Constructor Summary

Constructors

Constructor	Description
TextAnalyticsError(TextAnalyticsErrorCode errorCode, String message, String target)	Creates a TextAnalyticsError model that describes text analytics error.

Method Summary

Modifier and Type	Method	Description
static TextAnalyticsError	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of TextAnalyticsError from the JsonReader.
TextAnalyticsErrorCode	getErrorCode()	Get the code property: Error code.
String	getMessage()	Get the message property: Error message.
String	getTarget()	Get the target property: Error target.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

TextAnalyticsError

public TextAnalyticsError(TextAnalyticsErrorCode errorCode,
 String message,
 String target)

Creates a TextAnalyticsError model that describes text analytics error.

Parameters:

errorCode - The error code.

message - The error message.

target - The error target.

Method Details

getErrorCode

public TextAnalyticsErrorCode getErrorCode()

Get the code property: Error code. Possible values include: 'invalidRequest', 'invalidArgument', 'internalServerError', 'serviceUnavailable'.

Returns:

The code value.

getMessage

public String getMessage()

Get the message property: Error message.

Returns:

The message value.

getTarget

public String getTarget()

Get the target property: Error target.

Returns:

The target value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<TextAnalyticsError>

Throws:

IOException

fromJson

public static TextAnalyticsError fromJson(com.azure.json.JsonReader jsonReader)
                                   throws IOException

Reads an instance of TextAnalyticsError from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TextAnalyticsError if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the TextAnalyticsError.