Partilhar via


AnalyzeBatchOperationDetails Class

  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzeBatchOperationDetails

Implements

public final class AnalyzeBatchOperationDetails
implements JsonSerializable<AnalyzeBatchOperationDetails>

Status and result of the analyze batch operation.

Method Summary

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

Reads an instance of AnalyzeBatchOperationDetails from the JsonReader.

OffsetDateTime getCreatedOn()

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

DocumentIntelligenceError getError()

Get the error property: Encountered error during batch document analysis.

OffsetDateTime getLastUpdatedOn()

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

Integer getPercentCompleted()

Get the percentCompleted property: Operation progress (0-100).

AnalyzeBatchResult getResult()

Get the result property: Batch document analysis result.

String getResultId()

Get the resultId property: Analyze batch operation result ID.

DocumentIntelligenceOperationStatus getStatus()

Get the status property: Operation status.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static AnalyzeBatchOperationDetails fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeBatchOperationDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getCreatedOn

public OffsetDateTime getCreatedOn()

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

Returns:

the createdOn value.

getError

public DocumentIntelligenceError getError()

Get the error property: Encountered error during batch 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.

getPercentCompleted

public Integer getPercentCompleted()

Get the percentCompleted property: Operation progress (0-100).

Returns:

the percentCompleted value.

getResult

public AnalyzeBatchResult getResult()

Get the result property: Batch document analysis result.

Returns:

the result value.

getResultId

public String getResultId()

Get the resultId property: Analyze batch operation result ID.

Returns:

the resultId 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