Partilhar via

AnalyzeOperationDetails 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.AnalyzeOperationDetails

Implements

JsonSerializable<AnalyzeOperationDetails>

public final class AnalyzeOperationDetails
implements JsonSerializable<AnalyzeOperationDetails>

Status and result of the analyze operation.

Method Summary

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

Reads an instance of AnalyzeOperationDetails from the JsonReader.
AnalyzeResult getAnalyzeResult()

Get the analyzeResult property: Document analysis result.
OffsetDateTime getCreatedOn()

Get the createdOn property: Date and time (UTC) when the analyze operation was submitted.
DocumentIntelligenceError getError()

Get the error property: Encountered error during document analysis.
OffsetDateTime getLastUpdatedOn()

Get the lastUpdatedOn property: Date and time (UTC) when the status was last updated.
String getResultId()

Gets the operationId property: Operation ID.
DocumentIntelligenceOperationStatus getStatus()

Get the status property: Operation 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 AnalyzeOperationDetails fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeOperationDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAnalyzeResult

public AnalyzeResult getAnalyzeResult()

Get the analyzeResult property: Document analysis result.

Returns:

the analyzeResult value.

getCreatedOn

public OffsetDateTime getCreatedOn()

Get the createdOn property: Date and time (UTC) when the analyze operation was submitted.

Returns:

the createdOn value.

getError

public DocumentIntelligenceError getError()

Get the error property: Encountered error during document analysis.

Returns:

the error value.

getLastUpdatedOn

public OffsetDateTime getLastUpdatedOn()

Get the lastUpdatedOn property: Date and time (UTC) when the status was last updated.

Returns:

the lastUpdatedOn value.

getResultId

public String getResultId()

Gets the operationId property: Operation ID.

Returns:

the operationId value.

getStatus

public DocumentIntelligenceOperationStatus getStatus()

Get the status property: Operation status. notStarted, running, succeeded, or failed.

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to