ListDocumentStatusesOptionalParams interface

Pacote:

@azure/ai-translation-document

Parâmetros opcionais.

Extends

OperationOptions

Propriedades

createdAfter	o datetime de início para obter itens após
createdBefore	o datetime de término para obter itens antes
documentIds	IDs a serem usadas na filtragem
maxPageSize	maxPageSize é o máximo de itens retornados em uma página. Se mais itens forem solicitados via top (ou top não for especificado e houver mais itens a serem devolvidos),
orderBy	a consulta de ordenação para a coleção (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc')
skip	Pular indica o número de registros a pular da lista de registros mantidos pelo servidor com base no método de ordenação especificado. Por padrão, classificamos pela hora de início decrescente. Os clientes PODEM usar parâmetros de consulta superior e skip para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando tanto o topo quanto o skip são fornecidos por um cliente, o servidor DEVE primeiro aplicar o skip e depois o top na coleção. Nota: Se o servidor não conseguir honrar o topo e/ou pular, o servidor DEVE devolver um erro ao cliente informando sobre isso, em vez de simplesmente ignorar as opções de consulta.
statuses	Status a serem usados na filtragem
top	O topo indica o número total de registros que o usuário deseja que sejam devolvidos em todas as páginas. Os clientes PODEM usar parâmetros de consulta superior e skip para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando tanto o topo quanto o skip são fornecidos por um cliente, o servidor DEVE primeiro aplicar o skip e depois o top na coleção. Nota: Se o servidor não conseguir honrar o topo e/ou pular, o servidor DEVE devolver um erro ao cliente informando sobre isso, em vez de simplesmente ignorar as opções de consulta.

Propriedades herdadas

abortSignal	O sinal que pode ser usado para anular solicitações.
onResponse	Uma função a ser chamada sempre 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 da propriedade

createdAfter

o datetime de início para obter itens após

createdAfter?: Date

Valor da propriedade

Date

createdBefore

o datetime de término para obter itens antes

createdBefore?: Date

Valor da propriedade

Date

documentIds

IDs a serem usadas na filtragem

documentIds?: string[]

Valor da propriedade

string[]

maxPageSize

maxPageSize é o máximo de itens retornados em uma página. Se mais itens forem solicitados via top (ou top não for especificado e houver mais itens a serem devolvidos),

maxPageSize?: number

Valor da propriedade

number

orderBy

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

orderBy?: string[]

Valor da propriedade

string[]

skip

Pular indica o número de registros a pular da lista de registros mantidos pelo servidor com base no método de ordenação especificado. Por padrão, classificamos pela hora de início decrescente.

Os clientes PODEM usar parâmetros de consulta superior e skip para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando tanto o topo quanto o skip são fornecidos por um cliente, o servidor DEVE primeiro aplicar o skip e depois o top na coleção.

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

skip?: number

Valor da propriedade

number

statuses

Status a serem usados na filtragem

statuses?: string[]

Valor da propriedade

string[]

top

O topo indica o número total de registros que o usuário deseja que sejam devolvidos em todas as páginas.

Os clientes PODEM usar parâmetros de consulta superior e skip para especificar um número de resultados a serem retornados e um deslocamento na coleção. Quando tanto o topo quanto o skip são fornecidos por um cliente, o servidor DEVE primeiro aplicar o skip e depois o top na coleção.

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

top?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

abortSignal

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

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions