Package com.azure.ai.documentintelligence.models

Class DocumentIntelligenceError

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentIntelligenceError

All Implemented Interfaces:

com.azure.json.JsonSerializable<DocumentIntelligenceError>

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

The error object.

Method Summary

Modifier and Type	Method	Description
static DocumentIntelligenceError	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of DocumentIntelligenceError from the JsonReader.
String	getCode()	Get the code property: One of a server-defined set of error codes.
List<DocumentIntelligenceError>	getDetails()	Get the details property: An array of details about specific errors that led to this reported error.
DocumentIntelligenceInnerError	getInnerError()	Get the innerError property: An object containing more specific information than the current object about the error.
String	getMessage()	Get the message property: A human-readable representation of the error.
String	getTarget()	Get the target property: The target of the error.
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

Method Details

getCode

public String getCode()

Get the code property: One of a server-defined set of error codes.

Returns:

the code value.

getMessage

public String getMessage()

Get the message property: A human-readable representation of the error.

Returns:

the message value.

getTarget

public String getTarget()

Get the target property: The target of the error.

Returns:

the target value.

getDetails

public List<DocumentIntelligenceError> getDetails()

Get the details property: An array of details about specific errors that led to this reported error.

Returns:

the details value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of DocumentIntelligenceError from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentIntelligenceError 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 DocumentIntelligenceError.

getInnerError

public DocumentIntelligenceInnerError getInnerError()

Get the innerError property: An object containing more specific information than the current object about the error.

Returns:

the innerError value.