DocumentTranslationClient.GetTranslationsStatusAsync 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
| GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, RequestContext) |
[Protocol Method] Returns a list of batch requests submitted and the status for each request
|
| GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken) |
Returns a list of batch requests submitted and the status for each request. |
GetTranslationsStatusAsync(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 a list of batch requests submitted and the status for each request
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetTranslationsStatusAsync(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.AsyncPageable<BinaryData> GetTranslationsStatusAsync (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 GetTranslationsStatusAsync : Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTranslationsStatusAsync : Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>Public Overridable Function GetTranslationsStatusAsync (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 AsyncPageable(Of BinaryData)Parameters
$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.
- ids
- 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 AsyncPageable<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
GetTranslationsStatusAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IEnumerable<Guid>, IEnumerable<String>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, CancellationToken)
- Source:
- DocumentTranslationClient.cs
- Source:
- DocumentTranslationClient.cs
Returns a list of batch requests submitted and the status for each request.
public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.TranslationStatusResult> GetTranslationsStatusAsync (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 GetTranslationsStatusAsync : Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.Translation.Document.TranslationStatusResult>
override this.GetTranslationsStatusAsync : Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.Translation.Document.TranslationStatusResult>Public Overridable Function GetTranslationsStatusAsync (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 AsyncPageable(Of TranslationStatusResult)Parameters
$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.
- ids
- 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 a list of batch requests submitted and the status for each request. This list only contains batch requests submitted by the user (based on the resource).
If the number of requests 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 batches 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 operations. 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).
The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
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
Azure SDK for .NET