DocumentTranslationClient.GetDocumentsStatus 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
| GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) |
Returns the status for all documents in a batch document translation request. |
| GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext) |
[Protocol Method] Returns the status for all documents in a batch document translation request
|
GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)
- Source:
- DocumentTranslationClient.cs
- Source:
- DocumentTranslationClient.cs
Returns the status for all documents in a batch document translation request.
public virtual Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatus (Guid translationId, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Collections.Generic.IEnumerable<Guid> documentIds = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? createdDateTimeUtcStart = default, DateTimeOffset? createdDateTimeUtcEnd = default, System.Collections.Generic.IEnumerable<string> orderby = default, System.Threading.CancellationToken cancellationToken = default);public virtual Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatus (Guid id, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Collections.Generic.IEnumerable<Guid> ids = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? createdDateTimeUtcStart = default, DateTimeOffset? createdDateTimeUtcEnd = default, System.Collections.Generic.IEnumerable<string> orderby = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>Public Overridable Function GetDocumentsStatus (translationId As Guid, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional documentIds As IEnumerable(Of Guid) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional createdDateTimeUtcStart As Nullable(Of DateTimeOffset) = Nothing, Optional createdDateTimeUtcEnd As Nullable(Of DateTimeOffset) = Nothing, Optional orderby As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentStatusResult)Public Overridable Function GetDocumentsStatus (id As Guid, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional ids As IEnumerable(Of Guid) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional createdDateTimeUtcStart As Nullable(Of DateTimeOffset) = Nothing, Optional createdDateTimeUtcEnd As Nullable(Of DateTimeOffset) = Nothing, Optional orderby As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentStatusResult)Parameters
- translationIdid
- Guid
Format - uuid. The operation id.
top indicates the total number of records the user wants to be returned across all pages.
Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection.
Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.
Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection.
Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.
- documentIdsids
- IEnumerable<Guid>
Ids to use in filtering.
- statuses
- IEnumerable<String>
Statuses to use in filtering.
- createdDateTimeUtcStart
- Nullable<DateTimeOffset>
the start datetime to get items after.
- createdDateTimeUtcEnd
- Nullable<DateTimeOffset>
the end datetime to get items before.
- orderby
- IEnumerable<String>
the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc').
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Remarks
Returns the status for all documents in a batch document translation request.
If the number of documents in the response exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
top, skip and maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
top indicates the total number of records the user wants to be returned across all pages. skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time. maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.
orderby query parameter can be used to sort the returned list (ex "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc desc"). The default sorting is descending by createdDateTimeUtc. Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents. createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by. The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
When both top and skip are included, the server should first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server must return an error to the client informing about it instead of just ignoring the query options. This reduces the risk of the client making assumptions about the data returned.
Applies to
GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext)
- Source:
- DocumentTranslationClient.cs
- Source:
- DocumentTranslationClient.cs
[Protocol Method] Returns the status for all documents in a batch document translation request
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetDocumentsStatus(Guid, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Pageable<BinaryData> GetDocumentsStatus (Guid translationId, int? maxCount, int? skip, int? maxpagesize, System.Collections.Generic.IEnumerable<Guid> documentIds, System.Collections.Generic.IEnumerable<string> statuses, DateTimeOffset? createdDateTimeUtcStart, DateTimeOffset? createdDateTimeUtcEnd, System.Collections.Generic.IEnumerable<string> orderby, Azure.RequestContext context);public virtual Azure.Pageable<BinaryData> GetDocumentsStatus (Guid id, int? maxCount, int? skip, int? maxpagesize, System.Collections.Generic.IEnumerable<Guid> ids, System.Collections.Generic.IEnumerable<string> statuses, DateTimeOffset? createdDateTimeUtcStart, DateTimeOffset? createdDateTimeUtcEnd, System.Collections.Generic.IEnumerable<string> orderby, Azure.RequestContext context);abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>Public Overridable Function GetDocumentsStatus (translationId As Guid, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), documentIds As IEnumerable(Of Guid), statuses As IEnumerable(Of String), createdDateTimeUtcStart As Nullable(Of DateTimeOffset), createdDateTimeUtcEnd As Nullable(Of DateTimeOffset), orderby As IEnumerable(Of String), context As RequestContext) As Pageable(Of BinaryData)Public Overridable Function GetDocumentsStatus (id As Guid, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), ids As IEnumerable(Of Guid), statuses As IEnumerable(Of String), createdDateTimeUtcStart As Nullable(Of DateTimeOffset), createdDateTimeUtcEnd As Nullable(Of DateTimeOffset), orderby As IEnumerable(Of String), context As RequestContext) As Pageable(Of BinaryData)Parameters
- translationIdid
- Guid
Format - uuid. The operation id.
top indicates the total number of records the user wants to be returned across all pages.
Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection.
Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time.
Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection.
Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.
- documentIdsids
- IEnumerable<Guid>
Ids to use in filtering.
- statuses
- IEnumerable<String>
Statuses to use in filtering.
- createdDateTimeUtcStart
- Nullable<DateTimeOffset>
the start datetime to get items after.
- createdDateTimeUtcEnd
- Nullable<DateTimeOffset>
the end datetime to get items before.
- orderby
- IEnumerable<String>
the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc').
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.
Exceptions
Service returned a non-success status code.
Applies to
Azure SDK for .NET