DocumentTranslationClient.GetDocumentStatusAsync Method
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.
Overloads
| GetDocumentStatusAsync(Guid, Guid, RequestContext) |
[Protocol Method] Returns the status for a specific document
|
| GetDocumentStatusAsync(Guid, Guid, CancellationToken) |
Returns the status for a specific document. |
GetDocumentStatusAsync(Guid, Guid, RequestContext)
- Source:
- DocumentTranslationClient.cs
- Source:
- DocumentTranslationClient.cs
[Protocol Method] Returns the status for a specific document
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetDocumentStatusAsync(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetDocumentStatusAsync (Guid translationId, Guid documentId, Azure.RequestContext context);public virtual System.Threading.Tasks.Task<Azure.Response> GetDocumentStatusAsync (Guid id, Guid documentId, Azure.RequestContext context);abstract member GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>abstract member GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetDocumentStatusAsync (translationId As Guid, documentId As Guid, context As RequestContext) As Task(Of Response)Public Overridable Function GetDocumentStatusAsync (id As Guid, documentId As Guid, context As RequestContext) As Task(Of Response)Parameters
- translationIdid
- Guid
Format - uuid. The batch id.
- documentId
- Guid
Format - uuid. The document id.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
Applies to
GetDocumentStatusAsync(Guid, Guid, CancellationToken)
- Source:
- DocumentTranslationClient.cs
- Source:
- DocumentTranslationClient.cs
Returns the status for a specific document.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>> GetDocumentStatusAsync (Guid translationId, Guid documentId, System.Threading.CancellationToken cancellationToken = default);public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>> GetDocumentStatusAsync (Guid id, Guid documentId, System.Threading.CancellationToken cancellationToken = default);abstract member GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>
override this.GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>abstract member GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>
override this.GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>Public Overridable Function GetDocumentStatusAsync (translationId As Guid, documentId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentStatusResult))Public Overridable Function GetDocumentStatusAsync (id As Guid, documentId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentStatusResult))Parameters
- translationIdid
- Guid
Format - uuid. The batch id.
- documentId
- Guid
Format - uuid. The document id.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Remarks
Returns the translation status for a specific document based on the request Id and document Id.
