CreateDocumentModelOptions interface
Opções para a operação de criação do modelo.
- Extends
Propriedades Herdadas
abort |
O sinal que pode ser usado para abortar solicitações. |
description | Uma descrição textual do modelo (pode ser qualquer texto). |
on |
Um manipulador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este manipulador será chamado uma vez imediatamente após o estado do poller ser inicializado. |
on |
Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
request |
Opções usadas ao criar e enviar solicitações HTTP para esta operação. |
resume |
Um estado de poller serializado. Se fornecida, a operação de votação será retomada do estado em questão, em vez de iniciada como se fosse uma nova operação. |
serializer |
Opções para substituir o comportamento de serialização/desserialização. |
tags | Pares de chave-valor adicionais especificados pelo usuário para associar ao modelo como metadados persistentes. |
tracing |
Opções usadas quando o rastreamento está habilitado. |
update |
A quantidade de tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação. |
Detalhes da Propriedade Herdada
abortSignal
O sinal que pode ser usado para abortar solicitações.
abortSignal?: AbortSignalLike
Valor de Propriedade
herdado dePollerOptions.abortSignal
description
Uma descrição textual do modelo (pode ser qualquer texto).
description?: string
Valor de Propriedade
string
herdado deCommonModelCreationOptions.description
onProgress
Um manipulador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este manipulador será chamado uma vez imediatamente após o estado do poller ser inicializado.
onProgress?: (state: DocumentModelOperationState) => void
Valor de Propriedade
(state: DocumentModelOperationState) => void
herdado doPollerOptions.onProgress
onResponse
Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor de Propriedade
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para esta operação.
requestOptions?: OperationRequestOptions
Valor de Propriedade
herdado dePollerOptions.requestOptions
resumeFrom
Um estado de poller serializado. Se fornecida, a operação de votação será retomada do estado em questão, em vez de iniciada como se fosse uma nova operação.
resumeFrom?: string
Valor de Propriedade
string
herdado dePollerOptions.resumeFrom
serializerOptions
Opções para substituir o comportamento de serialização/desserialização.
serializerOptions?: SerializerOptions
Valor de Propriedade
herdado dePollerOptions.serializerOptions
tags
Pares de chave-valor adicionais especificados pelo usuário para associar ao modelo como metadados persistentes.
tags?: Record<string, string>
Valor de Propriedade
Record<string, string>
herdado deCommonModelCreationOptions.tags
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions
Valor de Propriedade
herdado doPollerOptions.tracingOptions
updateIntervalInMs
A quantidade de tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.
updateIntervalInMs?: number
Valor de Propriedade
number
herdado doPollerOptions.updateIntervalInMs