Package com.azure.ai.formrecognizer.administration.models

Class ModelOperation

java.lang.Object

com.azure.ai.formrecognizer.administration.models.ModelOperationInfo

com.azure.ai.formrecognizer.administration.models.ModelOperation

public final class ModelOperation
extends ModelOperationInfo

The ModelOperation model.

Constructor Summary

Constructors

Constructor	Description
ModelOperation()

Method Summary

Modifier and Type	Method	Description
OffsetDateTime	getCreatedOn()	Get the Date and time (UTC) when the analyze operation was submitted.
String	getDescription()	Get the model description.
Map<String,DocTypeInfo>	getDocTypes()	Get the supported document types.
DocumentModelOperationError	getError()	Get the error property: Encountered error.
ModelOperationKind	getKind()	Get the kind property: Type of operation.
OffsetDateTime	getLastUpdatedOn()	Get the lastUpdatedDateTime property: Date and time (UTC) when the status was last updated.
String	getModelId()	Get the Unique model identifier.
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.
ModelOperationStatus	getStatus()	Get the status property: Operation status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelOperation

public ModelOperation()

Method Detail

getModelId

public String getModelId()

Get the Unique model identifier.

Returns:

the modelId value.

getDescription

public String getDescription()

Get the model description.

Returns:

the description value.

getCreatedOn

public OffsetDateTime getCreatedOn()

Get the Date and time (UTC) when the analyze operation was submitted.

Overrides:

getCreatedOn in class ModelOperationInfo

Returns:

the createdDateTime value.

getDocTypes

public Map<String,DocTypeInfo> getDocTypes()

Get the supported document types.

Returns:

the docTypes value.

getError

public DocumentModelOperationError getError()

Get the error property: Encountered error.

Returns:

the error value.

getOperationId

public String getOperationId()

Description copied from class: ModelOperationInfo

Get the operationId property: Operation ID.

Overrides:

getOperationId in class ModelOperationInfo

Returns:

the operationId value.

getStatus

public ModelOperationStatus getStatus()

Description copied from class: ModelOperationInfo

Get the status property: Operation status.

Overrides:

getStatus in class ModelOperationInfo

Returns:

the status value.

getPercentCompleted

public Integer getPercentCompleted()

Description copied from class: ModelOperationInfo

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

Overrides:

getPercentCompleted in class ModelOperationInfo

Returns:

the percentCompleted value.

getLastUpdatedOn

public OffsetDateTime getLastUpdatedOn()

Description copied from class: ModelOperationInfo

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

Overrides:

getLastUpdatedOn in class ModelOperationInfo

Returns:

the lastUpdatedDateTime value.

getKind

public ModelOperationKind getKind()

Description copied from class: ModelOperationInfo

Get the kind property: Type of operation.

Overrides:

getKind in class ModelOperationInfo

Returns:

the kind value.

getResourceLocation

public String getResourceLocation()

Description copied from class: ModelOperationInfo

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

Overrides:

getResourceLocation in class ModelOperationInfo

Returns:

the resourceLocation value.