DurableClient class

Paquete:

durable-functions

Cliente para iniciar, consultar, finalizar y generar eventos en instancias de orquestación y entidad.

Propiedades

taskHubName

Nombre del centro de tareas configurado en esta instancia de cliente de orquestación.

Métodos

createCheckStatusResponse(undefined | HttpRequest, string)	Crea una respuesta HTTP que resulta útil para comprobar el estado de la instancia especificada.
createHttpManagementPayload(string)	Crea un objeto HttpManagementPayload que contiene puntos de conexión HTTP de administración de instancias.
getStatus(string, GetStatusOptions)	Obtiene el estado de la instancia de orquestación especificada.
getStatusAll()	Obtiene el estado de todas las instancias de orquestación.
getStatusBy(OrchestrationFilter)	Obtiene el estado de todas las instancias de orquestación que coinciden con las condiciones especificadas.
purgeInstanceHistory(string)	Purga el historial de una instancia de orquestación específica.
purgeInstanceHistoryBy(OrchestrationFilter)	Purga el historial de orquestaciones de instancias que coinciden con las condiciones.
raiseEvent(string, string, unknown, TaskHubOptions)	Envía un mensaje de notificación de evento a una instancia de orquestación en espera.
readEntityState<T>(EntityId, TaskHubOptions)	Intenta leer el estado actual de una entidad. Devuelve undefined si la entidad no existe o si el estado serializado json de la entidad es mayor que 16 KB.
rewind(string, string, TaskHubOptions)	Rebobina la instancia de orquestación con errores especificada por un motivo.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Indica a una entidad que realice una operación.
startNew(string, StartNewOptions)	Inicia una nueva instancia de la función de orquestador especificada. Si ya existe una instancia de orquestación con el identificador especificado, la instancia existente se reemplazará silenciosamente por esta nueva instancia.
terminate(string, string)	Finaliza una instancia de orquestación en ejecución.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Crea una respuesta HTTP que contiene una carga de direcciones URL de administración para una instancia no completada o contiene la carga que contiene la salida de la orquestación completada. Si la orquestación no se completa dentro del tiempo de espera especificado, la respuesta HTTP será idéntica a la de createCheckStatusResponse().

Detalles de las propiedades

taskHubName

Nombre del centro de tareas configurado en esta instancia de cliente de orquestación.

taskHubName: string

Valor de propiedad

string

Detalles del método

createCheckStatusResponse(undefined | HttpRequest, string)

Crea una respuesta HTTP que resulta útil para comprobar el estado de la instancia especificada.

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

Parámetros

request

undefined | HttpRequest

Solicitud HTTP que desencadenó la instancia de orquestación actual.

instanceId

string

Identificador de la instancia de orquestación que se va a comprobar.

Devoluciones

HttpResponse

Respuesta HTTP 202 con un encabezado Location y una carga que contiene direcciones URL de administración de instancias.

createHttpManagementPayload(string)

Crea un objeto HttpManagementPayload que contiene puntos de conexión HTTP de administración de instancias.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parámetros

instanceId

string

Identificador de la instancia de orquestación que se va a comprobar.

Devoluciones

HttpManagementPayload

getStatus(string, GetStatusOptions)

Obtiene el estado de la instancia de orquestación especificada.

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

Parámetros

instanceId

string

Identificador de la instancia de orquestación que se va a consultar.

options

GetStatusOptions

options (objeto) que especifica una configuración adicional

Devoluciones

Promise<DurableOrchestrationStatus>

getStatusAll()

Obtiene el estado de todas las instancias de orquestación.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Devoluciones

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Obtiene el estado de todas las instancias de orquestación que coinciden con las condiciones especificadas.

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

Parámetros

filter

OrchestrationFilter

El objeto OrchestrationFilter que especifica qué orquestaciones se van a recuperar.

Devoluciones

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Purga el historial de una instancia de orquestación específica.

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

Parámetros

instanceId

string

Identificador de la instancia de orquestación que se va a purgar.

Devoluciones

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Purga el historial de orquestaciones de instancias que coinciden con las condiciones.

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

Parámetros

filter

OrchestrationFilter

El objeto OrchestrationFilter que especifica qué orquestaciones se van a purgar.

Devoluciones

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Envía un mensaje de notificación de evento a una instancia de orquestación en espera.

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

Parámetros

instanceId

string

Identificador de la instancia de orquestación que controlará el evento.

eventName

string

Nombre del evento.

eventData

unknown

Datos serializables json asociados al evento.

options

TaskHubOptions

objeto que proporciona TaskHubName de la instancia de orquestación y el nombre de su cadena de conexión asociada

Devoluciones

Promise<void>

Promesa que se resuelve cuando se ha puesto en cola el mensaje de notificación de eventos.

Para controlar el evento, la instancia de orquestación de destino debe estar esperando un evento denominado eventName mediante waitForExternalEvent(string).

Si no se encuentra o no se ejecuta la instancia especificada, esta operación no tendrá ningún efecto.

readEntityState<T>(EntityId, TaskHubOptions)

Intenta leer el estado actual de una entidad. Devuelve undefined si la entidad no existe o si el estado serializado json de la entidad es mayor que 16 KB.

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

Parámetros

entityId

EntityId

Entidad de destino.

options

TaskHubOptions

objeto opcional que proporciona taskHubName de la entidad de destino y el nombre de su cadena de conexión asociada

Devoluciones

Promise<EntityStateResponse<T>>

Respuesta que contiene el estado actual de la entidad.

rewind(string, string, TaskHubOptions)

Rebobina la instancia de orquestación con errores especificada por un motivo.

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

Parámetros

instanceId

string

Identificador de la instancia de orquestación que se va a rebobinar.

reason

string

Motivo para rebobinar la instancia de orquestación.

options

TaskHubOptions

objeto que proporciona TaskHubName de la instancia de orquestación y el nombre de su cadena de conexión asociada

Devoluciones

Promise<void>

Promesa que se resuelve cuando el mensaje de rebobinado está en cola.

Esta característica está actualmente en versión preliminar.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Indica a una entidad que realice una operación.

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

Parámetros

entityId

EntityId

Entidad de destino.

operationName

string

Nombre de la operación.

operationContent

unknown

Contenido de la operación.

options

TaskHubOptions

objeto que proporciona TaskHubName de la instancia de entidad y el nombre de su cadena de conexión asociada

Devoluciones

Promise<void>

startNew(string, StartNewOptions)

Inicia una nueva instancia de la función de orquestador especificada.

Si ya existe una instancia de orquestación con el identificador especificado, la instancia existente se reemplazará silenciosamente por esta nueva instancia.

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

Parámetros

orchestratorFunctionName

string

Nombre de la función de orquestador que se va a iniciar.

options

StartNewOptions

objeto opcional para controlar el orquestador programado (por ejemplo, proporcionar entrada, instanceID)

Devoluciones

Promise<string>

Identificador de la nueva instancia de orquestación.

terminate(string, string)

Finaliza una instancia de orquestación en ejecución.

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

Parámetros

instanceId

string

Identificador de la instancia de orquestación que se va a finalizar.

reason

string

Motivo para finalizar la instancia de orquestación.

Devoluciones

Promise<void>

Promesa que se resuelve cuando se ponga en cola el mensaje de finalización.

La terminación de una instancia de orquestación no tiene ningún efecto en las ejecuciones de funciones de actividad en curso ni en las sub-orquestaciones iniciadas por la instancia de orquestación actual.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Crea una respuesta HTTP que contiene una carga de direcciones URL de administración para una instancia no completada o contiene la carga que contiene la salida de la orquestación completada.

Si la orquestación no se completa dentro del tiempo de espera especificado, la respuesta HTTP será idéntica a la de createCheckStatusResponse().

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

Parámetros

request

HttpRequest

Solicitud HTTP que desencadenó la función actual.

instanceId

string

Identificador único de la instancia que se va a comprobar.

waitOptions

WaitForCompletionOptions

options objeto que especifica los tiempos de espera durante cuánto tiempo se espera la salida de la función durable y la frecuencia con la que se comprueba la salida.

Devoluciones

Promise<HttpResponse>