BeginBuildDocumentModelOptions interface
Optionen für den Modellbuildvorgang.
- Extends
Geerbte Eigenschaften
abort |
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann. |
description | Eine textbezogene Beschreibung des Modells (kann ein beliebiger Text sein). |
on |
Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde. |
on |
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden. |
request |
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden. |
resume |
Ein serialisierter Umfragezustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt zu starten, als ob es sich um einen neuen Vorgang handelt. |
serializer |
Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens. |
tags | Zusätzliche, vom Benutzer angegebene Schlüsselwertpaare, die dem Modell als persistente Metadaten zugeordnet werden sollen. |
tracing |
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist. |
update |
Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang. |
Geerbte Eigenschaftsdetails
abortSignal
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
abortSignal?: AbortSignalLike
Eigenschaftswert
description
Eine textbezogene Beschreibung des Modells (kann ein beliebiger Text sein).
description?: string
Eigenschaftswert
string
onProgress
Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde.
onProgress?: (state: DocumentModelOperationState) => void
Eigenschaftswert
(state: DocumentModelOperationState) => void
geerbt vonCreateDocumentModelOptions.onProgress
onResponse
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
onResponse?: RawResponseCallback
Eigenschaftswert
geerbt vonCreateDocumentModelOptions.onResponse
requestOptions
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
requestOptions?: OperationRequestOptions
Eigenschaftswert
resumeFrom
Ein serialisierter Umfragezustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt zu starten, als ob es sich um einen neuen Vorgang handelt.
resumeFrom?: string
Eigenschaftswert
string
serializerOptions
Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
serializerOptions?: SerializerOptions
Eigenschaftswert
tags
Zusätzliche, vom Benutzer angegebene Schlüsselwertpaare, die dem Modell als persistente Metadaten zugeordnet werden sollen.
tags?: Record<string, string>
Eigenschaftswert
Record<string, string>
tracingOptions
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
tracingOptions?: OperationTracingOptions
Eigenschaftswert
updateIntervalInMs
Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.
updateIntervalInMs?: number
Eigenschaftswert
number