Partilhar via

DocumentIntelligenceOperationDetails Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentIntelligenceOperationDetails

Implements

JsonSerializable<DocumentIntelligenceOperationDetails>

public class DocumentIntelligenceOperationDetails
implements JsonSerializable<DocumentIntelligenceOperationDetails>

Operation info.

Constructor Summary

Modifier Constructor Description
protected DocumentIntelligenceOperationDetails(DocumentIntelligenceOperationStatus status, OffsetDateTime createdOn, OffsetDateTime lastUpdatedOn, String resourceLocation)

Creates an instance of DocumentIntelligenceOperationDetails class.

Method Summary

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

Reads an instance of DocumentIntelligenceOperationDetails from the JsonReader.
String getApiVersion()

Get the apiVersion property: API version used to create this operation.
OffsetDateTime getCreatedOn()

Get the createdOn property: Date and time (UTC) when the operation was created.
DocumentIntelligenceError getError()

Get the error property: Encountered error.
OperationKind getKind()

Get the kind property: Type of operation.
OffsetDateTime getLastUpdatedOn()

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

Get the operationId property: Operation ID.
Integer getPercentCompleted()

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

Get the resourceLocation property: URL of the resource targeted by this operation.
DocumentIntelligenceOperationStatus getStatus()

Get the status property: Operation status.
Map<String,String> getTags()

Get the tags property: List of key-value tag attributes associated with the document model.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static DocumentIntelligenceOperationDetails fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getApiVersion

public String getApiVersion()

Get the apiVersion property: API version used to create this operation.

Returns:

the apiVersion value.

getCreatedOn

public OffsetDateTime getCreatedOn()

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

Returns:

the createdOn value.

getError

public DocumentIntelligenceError getError()

Get the error property: Encountered error.

Returns:

the error value.

getKind

public OperationKind getKind()

Get the kind property: Type of operation.

Returns:

the kind value.

getLastUpdatedOn

public OffsetDateTime getLastUpdatedOn()

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

Returns:

the lastUpdatedOn value.

getOperationId

public String getOperationId()

Get the operationId property: Operation ID.

Returns:

the operationId value.

getPercentCompleted

public Integer getPercentCompleted()

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

Returns:

the percentCompleted value.

getResourceLocation

public String getResourceLocation()

Get the resourceLocation property: URL of the resource targeted by this operation.

Returns:

the resourceLocation value.

getStatus

public DocumentIntelligenceOperationStatus getStatus()

Get the status property: Operation status. notStarted, running, completed, or failed.

Returns:

the status value.

getTags

public Map getTags()

Get the tags property: List of key-value tag attributes associated with the document model.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to