Share via

ContentAnalyzerAnalyzeOperationStatus Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.ContentAnalyzerAnalyzeOperationStatus

Implements

JsonSerializable<ContentAnalyzerAnalyzeOperationStatus>

public final class ContentAnalyzerAnalyzeOperationStatus
implements JsonSerializable<ContentAnalyzerAnalyzeOperationStatus>

Provides status details for analyze operations.

Method Summary

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

Reads an instance of ContentAnalyzerAnalyzeOperationStatus from the JsonReader.
ResponseError getError()

Get the error property: Error object that describes the error when status is "Failed".
String getId()

Get the id property: The unique ID of the operation.
AnalysisResult getResult()

Get the result property: The result of the operation.
OperationState getStatus()

Get the status property: The status of the operation.
UsageDetails getUsage()

Get the usage property: Usage details of the analyze operation.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static ContentAnalyzerAnalyzeOperationStatus fromJson(JsonReader jsonReader)

Reads an instance of ContentAnalyzerAnalyzeOperationStatus from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContentAnalyzerAnalyzeOperationStatus 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.

getError

public ResponseError getError()

Get the error property: Error object that describes the error when status is "Failed".

Returns:

the error value.

getId

public String getId()

Get the id property: The unique ID of the operation.

Returns:

the id value.

getResult

public AnalysisResult getResult()

Get the result property: The result of the operation.

Returns:

the result value.

getStatus

public OperationState getStatus()

Get the status property: The status of the operation.

Returns:

the status value.

getUsage

public UsageDetails getUsage()

Get the usage property: Usage details of the analyze operation.

Returns:

the usage value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to