Package com.azure.ai.documentintelligence.models

Class AnalyzeOperationDetails

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeOperationDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeOperationDetails>
public final class AnalyzeOperationDetails extends Object implements com.azure.json.JsonSerializable<AnalyzeOperationDetails>
Status and result of the analyze operation.

  • Method Details

    • getStatus

      public DocumentIntelligenceOperationStatus getStatus()
      Get the status property: Operation status. notStarted, running, succeeded, or failed.
      Returns:
      the status value.

    • getCreatedOn

      public OffsetDateTime getCreatedOn()
      Get the createdOn property: Date and time (UTC) when the analyze operation was submitted.
      Returns:
      the createdOn value.

    • getLastUpdatedOn

      public OffsetDateTime getLastUpdatedOn()
      Get the lastUpdatedOn property: Date and time (UTC) when the status was last updated.
      Returns:
      the lastUpdatedOn value.

    • getError

      public DocumentIntelligenceError getError()
      Get the error property: Encountered error during document analysis.
      Returns:
      the error value.

    • getAnalyzeResult

      public AnalyzeResult getAnalyzeResult()
      Get the analyzeResult property: Document analysis result.
      Returns:
      the analyzeResult value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AnalyzeOperationDetails>
      Throws:
      IOException

    • fromJson

      public static AnalyzeOperationDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AnalyzeOperationDetails.

    • getResultId

      public String getResultId()
      Gets the operationId property: Operation ID.
      Returns:
      the operationId value.