Compartilhar via


CreateDocumentModelOptions interface

Opções para a operação de criação do modelo.

Extends

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

description

Uma descrição textual do modelo (pode ser qualquer texto).

onProgress

Um manipulador de progresso inicial opcional que será chamado quando o estado do sondador for atualizado. Esse manipulador será chamado uma vez imediatamente após o estado do poller ser inicializado.

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

resumeFrom

Um estado de sondagem serializado. Se fornecida, a operação de sondagem será retomada do estado especificado em vez de iniciada como se fosse uma nova operação.

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

tags

Pares chave-valor especificados pelo usuário adicionais a serem associados ao modelo como metadados persistentes.

tracingOptions

Opções usadas quando o rastreamento está habilitado.

updateIntervalInMs

O tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

Herdado dePollerOptions.abortSignal

description

Uma descrição textual do modelo (pode ser qualquer texto).

description?: string

Valor da propriedade

string

Herdado deCommonModelCreationOptions.description

onProgress

Um manipulador de progresso inicial opcional que será chamado quando o estado do sondador for atualizado. Esse manipulador será chamado uma vez imediatamente após o estado do poller ser inicializado.

onProgress?: (state: DocumentModelOperationState) => void

Valor da propriedade

(state: DocumentModelOperationState) => void

Herdado dePollerOptions.onProgress

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

Herdado dePollerOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

Herdado dePollerOptions.requestOptions

resumeFrom

Um estado de sondagem serializado. Se fornecida, a operação de sondagem será retomada do estado especificado em vez de iniciada como se fosse uma nova operação.

resumeFrom?: string

Valor da propriedade

string

Herdado dePollerOptions.resumeFrom

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor da propriedade

Herdado dePollerOptions.serializerOptions

tags

Pares chave-valor especificados pelo usuário adicionais a serem associados ao modelo como metadados persistentes.

tags?: Record<string, string>

Valor da propriedade

Record<string, string>

Herdado deCommonModelCreationOptions.tags

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado dePollerOptions.tracingOptions

updateIntervalInMs

O tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.

updateIntervalInMs?: number

Valor da propriedade

number

Herdado dePollerOptions.updateIntervalInMs