BeginComposeDocumentModelOptions interface
A modellírási művelet beállításai.
- Extends
Örökölt tulajdonságok
| abort |
A kérések megszakítására használható jel. |
| description | A modell szöveges leírása (bármilyen szöveg lehet). |
| on |
Választható kezdeti folyamatkezelő, amelyet a lekérdezés állapota frissítésekkor hív meg. A rendszer a lekérdezési állapot inicializálása után azonnal meghívja ezt a kezelőt. |
| on |
Minden alkalommal meghívandó függvény, amikor választ kap a kiszolgálótól a kért művelet végrehajtása közben. Többször is meghívható. |
| request |
A művelethez tartozó HTTP-kérések létrehozásakor és küldésekor használt beállítások. |
| resume |
Szerializált pollerállapot. Ha meg van adva, a lekérdezési művelet az új művelet helyett az adott állapotból folytatódik. |
| serializer |
A szerializálás/szerializálási viselkedés felülbírálásának lehetőségei. |
| tags | A modellhez állandó metaadatként társítandó további, felhasználó által megadott kulcs-érték párok. |
| tracing |
A nyomkövetés engedélyezésekor használt beállítások. |
| update |
A várakozási idő (ezredmásodpercben) az ugyanahhoz a művelethez kapcsolódó további kérelmek között. |
Örökölt tulajdonság részletei
abortSignal
A kérések megszakítására használható jel.
abortSignal?: AbortSignalLike
Tulajdonság értéke
description
A modell szöveges leírása (bármilyen szöveg lehet).
description?: string
Tulajdonság értéke
string
onProgress
Választható kezdeti folyamatkezelő, amelyet a lekérdezés állapota frissítésekkor hív meg. A rendszer a lekérdezési állapot inicializálása után azonnal meghívja ezt a kezelőt.
onProgress?: (state: DocumentModelOperationState) => void
Tulajdonság értéke
(state: DocumentModelOperationState) => void
onResponse
Minden alkalommal meghívandó függvény, amikor választ kap a kiszolgálótól a kért művelet végrehajtása közben. Többször is meghívható.
onResponse?: RawResponseCallback
Tulajdonság értéke
requestOptions
A művelethez tartozó HTTP-kérések létrehozásakor és küldésekor használt beállítások.
requestOptions?: OperationRequestOptions
Tulajdonság értéke
resumeFrom
Szerializált pollerállapot. Ha meg van adva, a lekérdezési művelet az új művelet helyett az adott állapotból folytatódik.
resumeFrom?: string
Tulajdonság értéke
string
serializerOptions
A szerializálás/szerializálási viselkedés felülbírálásának lehetőségei.
serializerOptions?: SerializerOptions
Tulajdonság értéke
tags
A modellhez állandó metaadatként társítandó további, felhasználó által megadott kulcs-érték párok.
tags?: Record<string, string>
Tulajdonság értéke
Record<string, string>
tracingOptions
A nyomkövetés engedélyezésekor használt beállítások.
tracingOptions?: OperationTracingOptions
Tulajdonság értéke
updateIntervalInMs
A várakozási idő (ezredmásodpercben) az ugyanahhoz a művelethez kapcsolódó további kérelmek között.
updateIntervalInMs?: number
Tulajdonság értéke
number