BeginComposeDocumentModelOptions interface
Opções para a operação de composição de modelos.
- Extends
Propriedades Herdadas
abort |
O sinal que pode ser utilizado para abortar pedidos. |
description | Uma descrição textual do modelo (pode ser qualquer texto). |
on |
Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após a inicialização do estado do poller. |
on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes. |
request |
Opções utilizadas ao criar e enviar pedidos HTTP para esta operação. |
resume |
Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada do estado especificado em vez de iniciada como se fosse uma nova operação. |
serializer |
Opções para substituir o comportamento de serialização/des serialização. |
tags | Pares chave-valor especificados pelo utilizador adicionais para associar ao modelo como metadados persistentes. |
tracing |
Opções utilizadas quando o rastreio está ativado. |
update |
A quantidade de tempo a aguardar (em milissegundos) entre os pedidos subsequentes relacionados com a mesma operação. |
Detalhes da Propriedade Herdada
abortSignal
O sinal que pode ser utilizado para abortar pedidos.
abortSignal?: AbortSignalLike
Valor de Propriedade
Herdado deCreateDocumentModelOptions.abortSignal
description
Uma descrição textual do modelo (pode ser qualquer texto).
description?: string
Valor de Propriedade
string
Herdado deCreateDocumentModelOptions.description
onProgress
Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após a inicialização do estado do poller.
onProgress?: (state: DocumentModelOperationState) => void
Valor de Propriedade
(state: DocumentModelOperationState) => void
Herdado deCreateDocumentModelOptions.onProgress
onResponse
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor de Propriedade
Herdado deCreateDocumentModelOptions.onResponse
requestOptions
Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.
requestOptions?: OperationRequestOptions
Valor de Propriedade
resumeFrom
Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada do estado especificado em vez de iniciada como se fosse uma nova operação.
resumeFrom?: string
Valor de Propriedade
string
Herdado deCreateDocumentModelOptions.resumeFrom
serializerOptions
Opções para substituir o comportamento de serialização/des serialização.
serializerOptions?: SerializerOptions
Valor de Propriedade
tags
Pares chave-valor especificados pelo utilizador adicionais para associar ao modelo como metadados persistentes.
tags?: Record<string, string>
Valor de Propriedade
Record<string, string>
Herdado deCreateDocumentModelOptions.tags
tracingOptions
Opções utilizadas quando o rastreio está ativado.
tracingOptions?: OperationTracingOptions
Valor de Propriedade
updateIntervalInMs
A quantidade de tempo a aguardar (em milissegundos) entre os pedidos subsequentes relacionados com a mesma operação.
updateIntervalInMs?: number
Valor de Propriedade
number