ListDocumentStatusesOptionalParams interface

Pacote:

@azure/ai-translation-document

Parâmetros opcionais.

Extends

OperationOptions

Propriedades

createdAfter	A data/hora de início para obter itens após
createdBefore	A data/hora final para obter itens antes
documentIds	Ids a utilizar na filtragem
maxPageSize	maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver),
orderBy	a consulta de ordenação para a coleção (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')
skip	Saltar indica o número de registos a saltar da lista de registos detidos pelo servidor, com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente. Os clientes PODEM usar parâmetros de topo e skip de consulta para especificar um número de resultados a devolver e um deslocamento para a coleção. Quando tanto o topo como o skip são dados por um cliente, o servidor DEVERÁ primeiro aplicar o skip e depois o top na coleção. Nota: Se o servidor não conseguir honrar o topo e/ou saltar, o servidor DEVE devolver um erro ao cliente a informar sobre isso em vez de simplesmente ignorar as opções de consulta.
statuses	Status a ser usado na filtragem
top	O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas. Os clientes PODEM usar parâmetros de topo e skip de consulta para especificar um número de resultados a devolver e um deslocamento para a coleção. Quando tanto o topo como o skip são dados por um cliente, o servidor DEVERÁ primeiro aplicar o skip e depois o top na coleção. Nota: Se o servidor não conseguir honrar o topo e/ou saltar, o servidor DEVE devolver um erro ao cliente a informar sobre isso em vez de simplesmente ignorar as opções de consulta.

Propriedades Herdadas

abortSignal	O sinal que pode ser usado para abortar solicitações.
onResponse	Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

createdAfter

A data/hora de início para obter itens após

createdAfter?: Date

Valor de Propriedade

Date

createdBefore

A data/hora final para obter itens antes

createdBefore?: Date

Valor de Propriedade

Date

documentIds

Ids a utilizar na filtragem

documentIds?: string[]

Valor de Propriedade

string[]

maxPageSize

maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver),

maxPageSize?: number

Valor de Propriedade

number

orderBy

a consulta de ordenação para a coleção (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')

orderBy?: string[]

Valor de Propriedade

string[]

skip

Saltar indica o número de registos a saltar da lista de registos detidos pelo servidor, com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente.

Os clientes PODEM usar parâmetros de topo e skip de consulta para especificar um número de resultados a devolver e um deslocamento para a coleção. Quando tanto o topo como o skip são dados por um cliente, o servidor DEVERÁ primeiro aplicar o skip e depois o top na coleção.

Nota: Se o servidor não conseguir honrar o topo e/ou saltar, o servidor DEVE devolver um erro ao cliente a informar sobre isso em vez de simplesmente ignorar as opções de consulta.

skip?: number

Valor de Propriedade

number

statuses

Status a ser usado na filtragem

statuses?: string[]

Valor de Propriedade

string[]

top

O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas.

Os clientes PODEM usar parâmetros de topo e skip de consulta para especificar um número de resultados a devolver e um deslocamento para a coleção. Quando tanto o topo como o skip são dados por um cliente, o servidor DEVERÁ primeiro aplicar o skip e depois o top na coleção.

Nota: Se o servidor não conseguir honrar o topo e/ou saltar, o servidor DEVE devolver um erro ao cliente a informar sobre isso em vez de simplesmente ignorar as opções de consulta.

top?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions