DocumentTranslationClient.GetDocumentStatus Method

Definition

Namespace:

Azure.AI.Translation.Document

Assembly:

Azure.AI.Translation.Document.dll

Package:

Azure.AI.Translation.Document v2.0.0-beta.2

Overloads

GetDocumentStatus(Guid, Guid, RequestContext)	[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 GetDocumentStatus(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.
GetDocumentStatus(Guid, Guid, CancellationToken)	Returns the status for a specific document.

GetDocumentStatus(Guid, Guid, RequestContext)

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 GetDocumentStatus(Guid, Guid, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetDocumentStatus (Guid id, Guid documentId, Azure.RequestContext context);

abstract member GetDocumentStatus : Guid * Guid * Azure.RequestContext -> Azure.Response
override this.GetDocumentStatus : Guid * Guid * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDocumentStatus (id As Guid, documentId As Guid, context As RequestContext) As Response

Parameters

id

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

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

GetDocumentStatus(Guid, Guid, CancellationToken)

Source:

DocumentTranslationClient.cs

Returns the status for a specific document.

public virtual Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentStatus (Guid id, Guid documentId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocumentStatus : Guid * Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentStatus : Guid * Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>

Public Overridable Function GetDocumentStatus (id As Guid, documentId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentStatusResult)

Parameters

id

Guid

Format - uuid. The batch id.

documentId

Guid

Format - uuid. The document id.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<DocumentStatusResult>

Remarks

Returns the translation status for a specific document based on the request Id and document Id.