ListDocumentStatusesOptionalParams interface

Package:

@azure/ai-translation-document

Optional parameters.

Extends

OperationOptions

Properties

createdAfter	the start datetime to get items after
createdBefore	the end datetime to get items before
documentIds	Ids to use in filtering
maxPageSize	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),
orderBy	the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')
skip	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.
statuses	Statuses to use in filtering
top	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.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Property Details

createdAfter

the start datetime to get items after

createdAfter?: Date

Property Value

Date

createdBefore

the end datetime to get items before

createdBefore?: Date

Property Value

Date

documentIds

Ids to use in filtering

documentIds?: string[]

Property Value

string[]

maxPageSize

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),

maxPageSize?: number

Property Value

number

orderBy

the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')

orderBy?: string[]

Property Value

string[]

skip

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.

skip?: number

Property Value

number

statuses

Statuses to use in filtering

statuses?: string[]

Property Value

string[]

top

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.

top?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions