DurableClient class

Pacote:

durable-functions

Cliente para iniciar, consultar, encerrar e elevar eventos para orquestração e instâncias de entidade.

Propriedades

taskHubName

O nome do hub de tarefas configurado nesta instância do cliente de orquestração.

Métodos

createCheckStatusResponse(undefined | HttpRequest, string)	Cria uma resposta HTTP que é útil para verificar o status da instância especificada.
createHttpManagementPayload(string)	Cria um objeto HttpManagementPayload que contém pontos de extremidade HTTP de gerenciamento de instância.
getStatus(string, GetStatusOptions)	Obtém o status da instância de orquestração especificada.
getStatusAll()	Obtém o status de todas as instâncias de orquestração.
getStatusBy(OrchestrationFilter)	Obtém o status de todas as instâncias de orquestração que correspondem às condições especificadas.
purgeInstanceHistory(string)	Limpe o histórico de uma instância de orquestração específica.
purgeInstanceHistoryBy(OrchestrationFilter)	Limpe o histórico de orquestração para instâncias que correspondam às condições.
raiseEvent(string, string, unknown, TaskHubOptions)	Envia uma mensagem de notificação de evento para uma instância de orquestração em espera.
readEntityState<T>(EntityId, TaskHubOptions)	Tenta ler o estado atual de uma entidade. Retorna undefined se a entidade não existir ou se o estado serializado em JSON da entidade for maior que 16KB.
rewind(string, string, TaskHubOptions)	Rebobina a instância de orquestração com falha especificada com um motivo.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Sinaliza uma entidade para executar uma operação.
startNew(string, StartNewOptions)	Inicia uma nova instância da função orchestrator especificada. Se já existir uma instância de orquestração com a ID especificada, a instância existente será substituída silenciosamente por essa nova instância.
terminate(string, string)	Encerra uma instância de orquestração em execução.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Cria uma resposta HTTP que contém uma carga de URLs de gerenciamento para uma instância não concluída ou contém a carga que contém a saída da orquestração concluída. Se a orquestração não for concluída dentro do tempo limite especificado, a resposta HTTP será idêntica à de createCheckStatusResponse().

Detalhes de Propriedade

taskHubName

O nome do hub de tarefas configurado nesta instância do cliente de orquestração.

taskHubName: string

Valor de Propriedade

string

Detalhes de Método

createCheckStatusResponse(undefined | HttpRequest, string)

Cria uma resposta HTTP que é útil para verificar o status da instância especificada.

function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponse

Parâmetros

request

undefined | HttpRequest

A solicitação HTTP que disparou a instância de orquestração atual.

instanceId

string

A ID da instância de orquestração a ser verificada.

Devoluções

HttpResponse

Uma resposta HTTP 202 com um cabeçalho Location e uma carga útil contendo URLs de gerenciamento de instância.

createHttpManagementPayload(string)

Cria um objeto HttpManagementPayload que contém pontos de extremidade HTTP de gerenciamento de instância.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parâmetros

instanceId

string

A ID da instância de orquestração a ser verificada.

Devoluções

HttpManagementPayload

getStatus(string, GetStatusOptions)

Obtém o status da instância de orquestração especificada.

function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>

Parâmetros

instanceId

string

A ID da instância de orquestração a ser consultada.

options

GetStatusOptions

objeto options especificando configuração extra

Devoluções

Promise<DurableOrchestrationStatus>

getStatusAll()

Obtém o status de todas as instâncias de orquestração.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Devoluções

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Obtém o status de todas as instâncias de orquestração que correspondem às condições especificadas.

function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>

Parâmetros

filter

OrchestrationFilter

o objeto OrchestrationFilter especificando quais orquestrações recuperar.

Devoluções

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Limpe o histórico de uma instância de orquestração específica.

function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>

Parâmetros

instanceId

string

A ID da instância de orquestração a ser limpa.

Devoluções

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Limpe o histórico de orquestração para instâncias que correspondam às condições.

function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>

Parâmetros

filter

OrchestrationFilter

o objeto OrchestrationFilter especificando quais orquestrações limpar.

Devoluções

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Envia uma mensagem de notificação de evento para uma instância de orquestração em espera.

function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>

Parâmetros

instanceId

string

A ID da instância de orquestração que manipulará o evento.

eventName

string

O nome do evento.

eventData

unknown

Os dados serializáveis por JSON associados ao evento.

options

TaskHubOptions

objeto que fornece TaskHubName da instância de orquestração e o nome de sua cadeia de conexão associada

Devoluções

Promise<void>

Uma promessa que é resolvida quando a mensagem de notificação de evento é enfileirada.

Para manipular o evento, a instância de orquestração de destino deve estar aguardando um evento chamado eventName usando waitForExternalEvent(string).

Se a instância especificada não for encontrada ou não estiver em execução, essa operação não terá efeito.

readEntityState<T>(EntityId, TaskHubOptions)

Tenta ler o estado atual de uma entidade. Retorna undefined se a entidade não existir ou se o estado serializado em JSON da entidade for maior que 16KB.

function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>

Parâmetros

entityId

EntityId

A entidade de destino.

options

TaskHubOptions

objeto opcional que fornece o TaskHubName da entidade de destino e o nome de sua cadeia de conexão associada

Devoluções

Promise<EntityStateResponse<T>>

Uma resposta contendo o estado atual da entidade.

rewind(string, string, TaskHubOptions)

Rebobina a instância de orquestração com falha especificada com um motivo.

function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>

Parâmetros

instanceId

string

A ID da instância de orquestração a ser retrocedida.

reason

string

A razão para rebobinar a instância de orquestração.

options

TaskHubOptions

objeto que fornece TaskHubName da instância de orquestração e o nome de sua cadeia de conexão associada

Devoluções

Promise<void>

Uma promessa que é resolvida quando a mensagem de retrocesso é enfileirada.

Esta funcionalidade está atualmente em pré-visualização.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Sinaliza uma entidade para executar uma operação.

function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>

Parâmetros

entityId

EntityId

A entidade de destino.

operationName

string

O nome da operação.

operationContent

unknown

O conteúdo da operação.

options

TaskHubOptions

objeto que fornece TaskHubName da instância da entidade e o nome de sua cadeia de conexão associada

Devoluções

Promise<void>

startNew(string, StartNewOptions)

Inicia uma nova instância da função orchestrator especificada.

Se já existir uma instância de orquestração com a ID especificada, a instância existente será substituída silenciosamente por essa nova instância.

function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>

Parâmetros

orchestratorFunctionName

string

O nome da função orquestradora a ser iniciada.

options

StartNewOptions

objeto opcional para controlar o orquestrador agendado (por exemplo, fornecer input, instanceID)

Devoluções

Promise<string>

A ID da nova instância de orquestração.

terminate(string, string)

Encerra uma instância de orquestração em execução.

function terminate(instanceId: string, reason: string): Promise<void>

Parâmetros

instanceId

string

A ID da instância de orquestração a ser encerrada.

reason

string

O motivo para encerrar a instância de orquestração.

Devoluções

Promise<void>

Uma promessa que é resolvida quando a mensagem de encerramento é enfileirada.

O encerramento de uma instância de orquestração não tem efeito sobre nenhuma atividade em voo, execuções de função ou suborquestrações que foram iniciadas pela instância de orquestração atual.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Cria uma resposta HTTP que contém uma carga de URLs de gerenciamento para uma instância não concluída ou contém a carga que contém a saída da orquestração concluída.

Se a orquestração não for concluída dentro do tempo limite especificado, a resposta HTTP será idêntica à de createCheckStatusResponse().

function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>

Parâmetros

request

HttpRequest

A solicitação HTTP que disparou a função atual.

instanceId

string

A ID exclusiva da instância a ser verificada.

waitOptions

WaitForCompletionOptions

Options que especifica os tempos limite de quanto tempo esperar pela saída da função durável e com que frequência verificar a saída.

Devoluções

Promise<HttpResponse>