BeginBuildDocumentModelOptions interface
Opcje operacji kompilacji modelu.
- Rozszerzenie
Właściwości dziedziczone
abort |
Sygnał, który może służyć do przerwania żądań. |
description | Tekstowy opis modelu (może to być dowolny tekst). |
on |
Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller. |
on |
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy. |
request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
resume |
Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja. |
serializer |
Opcje zastępowania zachowania serializacji/deseralizacji. |
tags | Dodatkowe pary klucz-wartość określone przez użytkownika do skojarzenia z modelem jako trwałe metadane. |
tracing |
Opcje używane podczas śledzenia są włączone. |
update |
Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji. |
Szczegóły właściwości dziedziczonej
abortSignal
Sygnał, który może służyć do przerwania żądań.
abortSignal?: AbortSignalLike
Wartość właściwości
dziedziczone zCreateDocumentModelOptions.abortSignal
description
Tekstowy opis modelu (może to być dowolny tekst).
description?: string
Wartość właściwości
string
dziedziczone zCreateDocumentModelOptions.description
onProgress
Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller.
onProgress?: (state: DocumentModelOperationState) => void
Wartość właściwości
(state: DocumentModelOperationState) => void
dziedziczone zCreateDocumentModelOptions.onProgress
onResponse
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
onResponse?: RawResponseCallback
Wartość właściwości
dziedziczone zCreateDocumentModelOptions.onResponse
requestOptions
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
requestOptions?: OperationRequestOptions
Wartość właściwości
dziedziczone zCreateDocumentModelOptions.requestOptions
resumeFrom
Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja.
resumeFrom?: string
Wartość właściwości
string
dziedziczone zCreateDocumentModelOptions.resumeFrom
serializerOptions
Opcje zastępowania zachowania serializacji/deseralizacji.
serializerOptions?: SerializerOptions
Wartość właściwości
dziedziczone zCreateDocumentModelOptions.serializerOptions
tags
Dodatkowe pary klucz-wartość określone przez użytkownika do skojarzenia z modelem jako trwałe metadane.
tags?: Record<string, string>
Wartość właściwości
Record<string, string>
dziedziczone zCreateDocumentModelOptions.tags
tracingOptions
Opcje używane podczas śledzenia są włączone.
tracingOptions?: OperationTracingOptions
Wartość właściwości
dziedziczone zCreateDocumentModelOptions.tracingOptions
updateIntervalInMs
Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji.
updateIntervalInMs?: number
Wartość właściwości
number
dziedziczone zCreateDocumentModelOptions.updateIntervalInMs