AnalyzeBatchOperationDetails Class
- java.
lang. Object - com.
azure. ai. documentintelligence. models. AnalyzeBatchOperationDetails
- com.
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
Analyze |
fromJson(JsonReader jsonReader)
Reads an instance of Analyze |
Offset |
getCreatedOn()
Get the created |
Document |
getError()
Get the error property: Encountered error during batch document analysis. |
Offset |
getLastUpdatedOn()
Get the last |
Integer |
getPercentCompleted()
Get the percent |
Analyze |
getResult()
Get the result property: Batch document analysis result. |
String |
getResultId()
Get the result |
Document |
getStatus()
Get the status property: Operation status. |
Json |
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:
Returns:
Throws:
getCreatedOn
public OffsetDateTime getCreatedOn()
Get the createdOn property: Date and time (UTC) when the operation was submitted.
Returns:
getError
public DocumentIntelligenceError getError()
Get the error property: Encountered error during batch document analysis.
Returns:
getLastUpdatedOn
public OffsetDateTime getLastUpdatedOn()
Get the lastUpdatedOn property: Date and time (UTC) when the status was last updated.
Returns:
getPercentCompleted
public Integer getPercentCompleted()
Get the percentCompleted property: Operation progress (0-100).
Returns:
getResult
public AnalyzeBatchResult getResult()
Get the result property: Batch document analysis result.
Returns:
getResultId
public String getResultId()
Get the resultId property: Analyze batch operation result ID.
Returns:
getStatus
public DocumentIntelligenceOperationStatus getStatus()
Get the status property: Operation status. notStarted, running, succeeded, or failed.
Returns:
toJson
Applies to
Azure SDK for Java