Package com.azure.ai.documentintelligence.models

Class AnalyzeBatchResultDetails

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeBatchResultDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeBatchResultDetails>
public final class AnalyzeBatchResultDetails extends Object implements com.azure.json.JsonSerializable<AnalyzeBatchResultDetails>
Operation detail for a document in a batch analysis.

  • Method Details

    • getStatus

      public DocumentIntelligenceOperationStatus getStatus()
      Get the status property: Analyze status. succeeded, failed, or skipped.
      Returns:
      the status value.

    • getSourceUrl

      public String getSourceUrl()
      Get the sourceUrl property: URL of the source document.
      Returns:
      the sourceUrl value.

    • getResultUrl

      public String getResultUrl()
      Get the resultUrl property: URL of the analyze result JSON.
      Returns:
      the resultUrl value.

    • getError

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

    • toJson

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

    • fromJson

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