ListDocumentStatusesOptionalParams interface

Paket:

@azure/ai-translation-document

Valfria parametrar.

Extends

OperationOptions

Egenskaper

createdAfter	startdatumtid för att hämta objekt efter
createdBefore	slutdatumet för att hämta objekt före
documentIds	ID:t som ska användas vid filtrering
maxPageSize	maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera),
orderBy	sorteringsfrågan för samlingen (t.ex. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc beskrivning')
skip	Skip anger antalet poster som ska hoppas över från listan över poster som servern har baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid. Klienter KAN använda top- och skip-frågeparameterna för att specificera ett antal resultat att returnera och en offset in i samlingen. När både top och skip ges av en klient, BÖR servern först applicera skip och sedan top på samlingen. Notera: Om servern inte kan godkänna top och/eller hoppa över måste servern returnera ett felmeddelande till klienten och informera om det istället för att bara ignorera frågealternativen.
statuses	Statusar som ska användas i filtrering
top	Top anger det totala antalet poster som användaren vill ska returneras över alla sidor. Klienter KAN använda top- och skip-frågeparameterna för att specificera ett antal resultat att returnera och en offset in i samlingen. När både top och skip ges av en klient, BÖR servern först applicera skip och sedan top på samlingen. Notera: Om servern inte kan godkänna top och/eller hoppa över måste servern returnera ett felmeddelande till klienten och informera om det istället för att bara ignorera frågealternativen.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

createdAfter

startdatumtid för att hämta objekt efter

createdAfter?: Date

Egenskapsvärde

Date

createdBefore

slutdatumet för att hämta objekt före

createdBefore?: Date

Egenskapsvärde

Date

documentIds

ID:t som ska användas vid filtrering

documentIds?: string[]

Egenskapsvärde

string[]

maxPageSize

maxPageSize är det maximala antalet objekt som returneras på en sida. Om fler föremål begärs via top (eller top inte anges och det finns fler saker att returnera),

maxPageSize?: number

Egenskapsvärde

number

orderBy

sorteringsfrågan för samlingen (t.ex. 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc beskrivning')

orderBy?: string[]

Egenskapsvärde

string[]

skip

Skip anger antalet poster som ska hoppas över från listan över poster som servern har baserat på den angivna sorteringsmetoden. Som standard sorterar vi efter fallande starttid.

Klienter KAN använda top- och skip-frågeparameterna för att specificera ett antal resultat att returnera och en offset in i samlingen. När både top och skip ges av en klient, BÖR servern först applicera skip och sedan top på samlingen.

Notera: Om servern inte kan godkänna top och/eller hoppa över måste servern returnera ett felmeddelande till klienten och informera om det istället för att bara ignorera frågealternativen.

skip?: number

Egenskapsvärde

number

statuses

Statusar som ska användas i filtrering

statuses?: string[]

Egenskapsvärde

string[]

top

Top anger det totala antalet poster som användaren vill ska returneras över alla sidor.

Klienter KAN använda top- och skip-frågeparameterna för att specificera ett antal resultat att returnera och en offset in i samlingen. När både top och skip ges av en klient, BÖR servern först applicera skip och sedan top på samlingen.

Notera: Om servern inte kan godkänna top och/eller hoppa över måste servern returnera ett felmeddelande till klienten och informera om det istället för att bara ignorera frågealternativen.

top?: number

Egenskapsvärde

number

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

ärvd från OperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

ärvd från OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

ärvd från OperationOptions.requestOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd från OperationOptions.tracingOptions