DocumentTranslationOperation Class
Definition
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 translating documents.
public class DocumentTranslationOperation : Azure.PageableOperation<Azure.AI.Translation.Document.DocumentStatusResult>type DocumentTranslationOperation = class
inherit PageableOperation<DocumentStatusResult>Public Class DocumentTranslationOperation
Inherits PageableOperation(Of DocumentStatusResult)- Inheritance
-
DocumentTranslationOperation
Constructors
| DocumentTranslationOperation() |
Protected constructor to allow mocking. |
| DocumentTranslationOperation(String, DocumentTranslationClient) |
Initializes a new instance of the DocumentTranslationOperation class. |
Properties
| CreatedOn |
The date time when the translation operation was created. |
| DocumentsCanceled |
Number of documents canceled. |
| DocumentsFailed |
Number of documents failed to translate. |
| DocumentsInProgress |
Number of documents in progress. |
| DocumentsNotStarted |
Number of documents in queue for translation. |
| DocumentsSucceeded |
Number of documents translated successfully. |
| DocumentsTotal |
Total number of expected translated documents. |
| HasCompleted |
Returns true if the long-running operation has 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 translation operation that can be used to poll for the status of the long-running operation. |
| LastModified |
The date time when the translation operation's status was last updated. |
| Status |
The current status of the translation operation. |
| Value |
Final result of the long-running operation. (Inherited from Operation<T>) |
Methods
| Cancel(CancellationToken) |
Cancel a running translation operation. |
| CancelAsync(CancellationToken) |
Cancel a running translation operation. |
| GetDocumentStatus(String, CancellationToken) |
Get the status of a specific document in the translation operation. |
| GetDocumentStatusAsync(String, CancellationToken) |
Get the status of a specific document in the translation operation. |
| GetDocumentStatuses(GetDocumentStatusesOptions, CancellationToken) |
Get the status of documents in the translation operation. |
| GetDocumentStatusesAsync(GetDocumentStatusesOptions, CancellationToken) |
Get the status of documents in the translation operation. |
| GetRawResponse() |
The last HTTP response received from the server. |
| GetRehydrationToken() |
Get a token that can be used to rehydrate the operation. (Inherited from Operation) |
| GetValues(CancellationToken) |
Gets the final result of the long-running operation synchronously. |
| GetValuesAsync(CancellationToken) |
Gets the final result of the long-running operation asynchronously. |
| 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) |
