AnalyzeDocumentOperation Class

Reference

Definition

Namespace:: Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:: Azure.AI.FormRecognizer.dll

Package:: Azure.AI.FormRecognizer v4.1.0

Source:: AnalyzeDocumentOperation.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Tracks the status of a long-running operation for analyzing documents.

public class AnalyzeDocumentOperation : Azure.Operation<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeResult>

type AnalyzeDocumentOperation = class
    inherit Operation<AnalyzeResult>

Public Class AnalyzeDocumentOperation
Inherits Operation(Of AnalyzeResult)

Inheritance: Object

Operation

Operation<AnalyzeResult>
AnalyzeDocumentOperation

Constructors

AnalyzeDocumentOperation()	Initializes a new instance of the AnalyzeDocumentOperation class. This constructor is intended to be used for mocking only.
AnalyzeDocumentOperation(String, DocumentAnalysisClient)	Initializes a new instance of the AnalyzeDocumentOperation class which tracks the status of a long-running operation for analyzing documents.

Properties

HasCompleted	Returns true if the long-running operation completed.
HasValue	Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property).
Id	Gets an ID representing the operation that can be used to poll for the status of the long-running operation.
Value	Final result of the long-running operation.

Methods

GetRawResponse()	The last HTTP response received from the server.
GetRehydrationToken()	Get a token that can be used to rehydrate the operation. (Inherited from Operation)
UpdateStatus(CancellationToken)	Calls the server to get updated status of the long-running operation.
UpdateStatusAsync(CancellationToken)	Calls the server to get updated status of the long-running operation.
WaitForCompletion(CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation<T>)
WaitForCompletion(DelayStrategy, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation<T>)
WaitForCompletion(TimeSpan, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation<T>)
WaitForCompletionAsync(CancellationToken)	Periodically calls the server till the long-running operation completes.
WaitForCompletionAsync(DelayStrategy, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation<T>)
WaitForCompletionAsync(TimeSpan, CancellationToken)	Periodically calls the server till the long-running operation completes.
WaitForCompletionResponse(CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)
WaitForCompletionResponse(DelayStrategy, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)
WaitForCompletionResponse(TimeSpan, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)
WaitForCompletionResponseAsync(CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)
WaitForCompletionResponseAsync(DelayStrategy, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)
WaitForCompletionResponseAsync(TimeSpan, CancellationToken)	Periodically calls the server till the long-running operation completes. (Inherited from Operation)

Applies to

Share via