Package com.azure.ai.documentintelligence.models

Class DocumentIntelligenceOperationDetails

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentIntelligenceOperationDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentIntelligenceOperationDetails>
Direct Known Subclasses:
DocumentClassifierBuildOperationDetails, DocumentClassifierCopyToOperationDetails, DocumentModelBuildOperationDetails, DocumentModelComposeOperationDetails, DocumentModelCopyToOperationDetails
public class DocumentIntelligenceOperationDetails extends Object implements com.azure.json.JsonSerializable<DocumentIntelligenceOperationDetails>
Operation info.

  • Constructor Details

    • DocumentIntelligenceOperationDetails

      protected DocumentIntelligenceOperationDetails(DocumentIntelligenceOperationStatus status, OffsetDateTime createdOn, OffsetDateTime lastUpdatedOn, String resourceLocation)
      Creates an instance of DocumentIntelligenceOperationDetails class.
      Parameters:
      status - the status value to set.
      createdOn - the createdOn value to set.
      lastUpdatedOn - the lastUpdatedOn value to set.
      resourceLocation - the resourceLocation value to set.

  • Method Details

    • getKind

      public OperationKind getKind()
      Get the kind property: Type of operation.
      Returns:
      the kind value.

    • getOperationId

      public String getOperationId()
      Get the operationId property: Operation ID.
      Returns:
      the operationId value.

    • getStatus

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

    • getPercentCompleted

      public Integer getPercentCompleted()
      Get the percentCompleted property: Operation progress (0-100).
      Returns:
      the percentCompleted value.

    • getCreatedOn

      public OffsetDateTime getCreatedOn()
      Get the createdOn property: Date and time (UTC) when the operation was created.
      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.

    • getResourceLocation

      public String getResourceLocation()
      Get the resourceLocation property: URL of the resource targeted by this operation.
      Returns:
      the resourceLocation value.

    • getApiVersion

      public String getApiVersion()
      Get the apiVersion property: API version used to create this operation.
      Returns:
      the apiVersion value.

    • getTags

      public Map<String,String> getTags()
      Get the tags property: List of key-value tag attributes associated with the document model.
      Returns:
      the tags 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<DocumentIntelligenceOperationDetails>
      Throws:
      IOException

    • fromJson

      public static DocumentIntelligenceOperationDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentIntelligenceOperationDetails from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentIntelligenceOperationDetails 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 DocumentIntelligenceOperationDetails.