Package com.azure.ai.documentintelligence.models

Class AnalyzeBatchOperationDetail

java.lang.Object

com.azure.ai.documentintelligence.models.AnalyzeBatchOperationDetail

All Implemented Interfaces:

com.azure.json.JsonSerializable<AnalyzeBatchOperationDetail>

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

Operation detail for a document in a batch analysis.

Method Summary

Modifier and Type	Method	Description
static AnalyzeBatchOperationDetail	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AnalyzeBatchOperationDetail from the JsonReader.
Error	getError()	Get the error property: Encountered error.
String	getResultUrl()	Get the resultUrl property: URL of the analyze result JSON.
String	getSourceUrl()	Get the sourceUrl property: URL of the source document.
OperationStatus	getStatus()	Get the status property: Analyze status.
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

getStatus

public OperationStatus getStatus()

Get the status property: Analyze status. succeeded, failed, or skipped.

Returns:

the status value.

getSourceUrl

public String getSourceUrl()

Get the sourceUrl property: URL of the source document.

Returns:

the sourceUrl value.

getResultUrl

public String getResultUrl()

Get the resultUrl property: URL of the analyze result JSON.

Returns:

the resultUrl value.

getError

public Error getError()

Get the error property: Encountered error.

Returns:

the error value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of AnalyzeBatchOperationDetail from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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