Partilhar via

AnalyzeBatchResultDetails Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzeBatchResultDetails

Implements

JsonSerializable<AnalyzeBatchResultDetails>

public final class AnalyzeBatchResultDetails
implements JsonSerializable<AnalyzeBatchResultDetails>

Operation detail for a document in a batch analysis.

Method Summary

Modifier and Type Method and Description
static AnalyzeBatchResultDetails fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeBatchResultDetails from the JsonReader.
DocumentIntelligenceError 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.
DocumentIntelligenceOperationStatus getStatus()

Get the status property: Analyze status.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AnalyzeBatchResultDetails fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeBatchResultDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getError

public DocumentIntelligenceError getError()

Get the error property: Encountered error.

Returns:

the error value.

getResultUrl

public String getResultUrl()

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

Returns:

the resultUrl value.

getSourceUrl

public String getSourceUrl()

Get the sourceUrl property: URL of the source document.

Returns:

the sourceUrl value.

getStatus

public DocumentIntelligenceOperationStatus getStatus()

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

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to