CreateDocumentModelOptions interface
Opciones para la operación de creación del modelo.
- Extends
Propiedades heredadas
abort |
Señal que se puede usar para anular las solicitudes. |
description | Una descripción textual del modelo (puede ser cualquier texto). |
on |
Controlador de progreso inicial opcional al que se llamará cuando se actualice el estado del sondeo. Se llamará a este controlador una vez inmediatamente después de inicializar el estado del sondeo. |
on |
Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces. |
request |
Opciones usadas al crear y enviar solicitudes HTTP para esta operación. |
resume |
Un estado de sondeo serializado. Si se proporciona, la operación de sondeo se reanudará desde el estado especificado en lugar de iniciarse como si fuera una nueva operación. |
serializer |
Opciones para invalidar el comportamiento de serialización o des serialización. |
tags | Pares clave-valor adicionales especificados por el usuario para asociar con el modelo como metadatos persistentes. |
tracing |
Opciones usadas al habilitar el seguimiento. |
update |
Cantidad de tiempo de espera (en milisegundos) entre solicitudes posteriores relacionadas con la misma operación. |
Detalles de las propiedades heredadas
abortSignal
Señal que se puede usar para anular las solicitudes.
abortSignal?: AbortSignalLike
Valor de propiedad
Heredado dePollerOptions.abortSignal
description
Una descripción textual del modelo (puede ser cualquier texto).
description?: string
Valor de propiedad
string
Heredado deCommonModelCreationOptions.description
onProgress
Controlador de progreso inicial opcional al que se llamará cuando se actualice el estado del sondeo. Se llamará a este controlador una vez inmediatamente después de inicializar el estado del sondeo.
onProgress?: (state: DocumentModelOperationState) => void
Valor de propiedad
(state: DocumentModelOperationState) => void
Heredado dePollerOptions.onProgress
onResponse
Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
onResponse?: RawResponseCallback
Valor de propiedad
Heredado dePollerOptions.onResponse
requestOptions
Opciones usadas al crear y enviar solicitudes HTTP para esta operación.
requestOptions?: OperationRequestOptions
Valor de propiedad
Heredado dePollerOptions.requestOptions
resumeFrom
Un estado de sondeo serializado. Si se proporciona, la operación de sondeo se reanudará desde el estado especificado en lugar de iniciarse como si fuera una nueva operación.
resumeFrom?: string
Valor de propiedad
string
Heredado dePollerOptions.resumeFrom
serializerOptions
Opciones para invalidar el comportamiento de serialización o des serialización.
serializerOptions?: SerializerOptions
Valor de propiedad
Heredado dePollerOptions.serializerOptions
tags
Pares clave-valor adicionales especificados por el usuario para asociar con el modelo como metadatos persistentes.
tags?: Record<string, string>
Valor de propiedad
Record<string, string>
Se hereda deCommonModelCreationOptions.tags
tracingOptions
Opciones usadas al habilitar el seguimiento.
tracingOptions?: OperationTracingOptions
Valor de propiedad
Heredado dePollerOptions.tracingOptions
updateIntervalInMs
Cantidad de tiempo de espera (en milisegundos) entre solicitudes posteriores relacionadas con la misma operación.
updateIntervalInMs?: number
Valor de propiedad
number
Heredado dePollerOptions.updateIntervalInMs