CreateDocumentModelOptions interface
Možnosti pro operaci vytvoření modelu
- Extends
Zděděné vlastnosti
abort |
Signál, který lze použít k přerušení požadavků. |
description | Textový popis modelu (může být libovolný text). |
on |
Volitelná počáteční obslužná rutina průběhu, která bude volána při aktualizaci stavu poller. Tato obslužná rutina bude volána jednou okamžitě po inicializaci stavu poller. |
on |
Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát. |
request |
Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci |
resume |
Serializovaný stav poller. Pokud je operace dotazování poskytnuta, bude obnovena z daného stavu, místo aby se spustila, jako by se jednalo o novou operaci. |
serializer |
Možnosti přepsání chování serializace nebo de-serializace. |
tags | Další páry klíč-hodnota zadané uživatelem, které se přidružují k modelu jako trvalá metadata. |
tracing |
Možnosti použité při povoleném trasování |
update |
Doba čekání (v milisekundách) mezi následnými požadavky týkajícími se stejné operace. |
Podrobnosti zděděných vlastností
abortSignal
Signál, který lze použít k přerušení požadavků.
abortSignal?: AbortSignalLike
Hodnota vlastnosti
Zděděno zPollerOptions.abortSignal
description
Textový popis modelu (může být libovolný text).
description?: string
Hodnota vlastnosti
string
onProgress
Volitelná počáteční obslužná rutina průběhu, která bude volána při aktualizaci stavu poller. Tato obslužná rutina bude volána jednou okamžitě po inicializaci stavu poller.
onProgress?: (state: DocumentModelOperationState) => void
Hodnota vlastnosti
(state: DocumentModelOperationState) => void
Zděděno zPollerOptions.onProgress
onResponse
Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.
onResponse?: RawResponseCallback
Hodnota vlastnosti
Zděděno zPollerOptions.onResponse
requestOptions
Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
requestOptions?: OperationRequestOptions
Hodnota vlastnosti
Zděděno zPollerOptions.requestOptions
resumeFrom
Serializovaný stav poller. Pokud je operace dotazování poskytnuta, bude obnovena z daného stavu, místo aby se spustila, jako by se jednalo o novou operaci.
resumeFrom?: string
Hodnota vlastnosti
string
Zděděno zPollerOptions.resumeFrom
serializerOptions
Možnosti přepsání chování serializace nebo de-serializace.
serializerOptions?: SerializerOptions
Hodnota vlastnosti
Zděděno zPollerOptions.serializerOptions
tags
Další páry klíč-hodnota zadané uživatelem, které se přidružují k modelu jako trvalá metadata.
tags?: Record<string, string>
Hodnota vlastnosti
Record<string, string>
Zděděno zCommonModelCreationOptions.tags
tracingOptions
Možnosti použité při povoleném trasování
tracingOptions?: OperationTracingOptions
Hodnota vlastnosti
Zděděno zPollerOptions.tracingOptions
updateIntervalInMs
Doba čekání (v milisekundách) mezi následnými požadavky týkajícími se stejné operace.
updateIntervalInMs?: number
Hodnota vlastnosti
number
Zděděno zPollerOptions.updateIntervalInMs