DurableClient class

Paket:

durable-functions

Klient för att starta, fråga, avsluta och höja händelser till orkestrerings- och entitetsinstanser.

Egenskaper

taskHubName

Namnet på aktivitetshubben som konfigurerats på den här orkestreringsklientinstansen.

Metoder

createCheckStatusResponse(undefined | HttpRequest, string)	Skapar ett HTTP-svar som är användbart för att kontrollera status för den angivna instansen.
createHttpManagementPayload(string)	Skapar ett HttpManagementPayload-objekt som innehåller HTTP-slutpunkter för instanshantering.
getStatus(string, GetStatusOptions)	Hämtar status för den angivna orkestreringsinstansen.
getStatusAll()	Hämtar status för alla orkestreringsinstanser.
getStatusBy(OrchestrationFilter)	Hämtar status för alla orkestreringsinstanser som matchar de angivna villkoren.
purgeInstanceHistory(string)	Rensa historiken för en specifik orkestreringsinstans.
purgeInstanceHistoryBy(OrchestrationFilter)	Rensa orkestreringshistoriken för instanser som matchar villkoren.
raiseEvent(string, string, unknown, TaskHubOptions)	Skickar ett händelsemeddelande till en väntande orkestreringsinstans.
readEntityState<T>(EntityId, TaskHubOptions)	Försöker läsa det aktuella tillståndet för en entitet. Returnerar odefinierat om entiteten inte finns eller om JSON-serialiserat tillstånd för entiteten är större än 16 KB.
rewind(string, string, TaskHubOptions)	Spolar tillbaka den angivna misslyckade orkestreringsinstansen med en orsak.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Signalerar en entitet för att utföra en åtgärd.
startNew(string, StartNewOptions)	Startar en ny instans av den angivna orchestrator-funktionen. Om det redan finns en orkestreringsinstans med angivet ID ersätts den befintliga instansen tyst av den nya instansen.
terminate(string, string)	Avslutar en orkestreringsinstans som körs.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Skapar ett HTTP-svar som antingen innehåller en nyttolast med hanterings-URL:er för en icke-slutförd instans eller innehåller nyttolasten som innehåller utdata från den slutförda orkestreringen. Om orkestreringen inte slutförs inom den angivna tidsgränsen är HTTP-svaret identiskt med createCheckStatusResponse().

Egenskapsinformation

taskHubName

Namnet på aktivitetshubben som konfigurerats på den här orkestreringsklientinstansen.

taskHubName: string

Egenskapsvärde

string

Metodinformation

createCheckStatusResponse(undefined | HttpRequest, string)

Skapar ett HTTP-svar som är användbart för att kontrollera status för den angivna instansen.

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

Parametrar

request

undefined | HttpRequest

HTTP-begäran som utlöste den aktuella orkestreringsinstansen.

instanceId

string

ID:t för orkestreringsinstansen som ska kontrolleras.

Returer

HttpResponse

Ett HTTP 202-svar med en platsrubrik och en nyttolast som innehåller url:er för instanshantering.

createHttpManagementPayload(string)

Skapar ett HttpManagementPayload-objekt som innehåller HTTP-slutpunkter för instanshantering.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parametrar

instanceId

string

ID:t för orkestreringsinstansen som ska kontrolleras.

Returer

HttpManagementPayload

getStatus(string, GetStatusOptions)

Hämtar status för den angivna orkestreringsinstansen.

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

Parametrar

instanceId

string

ID:t för orkestreringsinstansen som ska frågas.

options

GetStatusOptions

alternativobjekt som anger extra konfiguration

Returer

Promise<DurableOrchestrationStatus>

getStatusAll()

Hämtar status för alla orkestreringsinstanser.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Returer

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Hämtar status för alla orkestreringsinstanser som matchar de angivna villkoren.

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

Parametrar

filter

OrchestrationFilter

OrchestrationFilter-objektet som anger vilka orkestreringar som ska hämtas.

Returer

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Rensa historiken för en specifik orkestreringsinstans.

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

Parametrar

instanceId

string

ID för orkestreringsinstansen som ska rensas.

Returer

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Rensa orkestreringshistoriken för instanser som matchar villkoren.

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

Parametrar

filter

OrchestrationFilter

OrchestrationFilter-objektet som anger vilka orkestreringar som ska rensas.

Returer

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Skickar ett händelsemeddelande till en väntande orkestreringsinstans.

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

Parametrar

instanceId

string

ID:t för orkestreringsinstansen som ska hantera händelsen.

eventName

string

Namnet på händelsen.

eventData

unknown

JSON-serialiserbara data som är associerade med händelsen.

options

TaskHubOptions

objekt som tillhandahåller TaskHubName för orkestreringsinstansen och namnet på dess associerade anslutningssträng

Returer

Promise<void>

Ett löfte som löser när händelsemeddelandet har angetts.

För att kunna hantera händelsen måste målorkestreringsinstansen vänta på en händelse med namnet eventName med hjälp av waitForExternalEvent(string).

Om den angivna instansen inte hittas eller inte körs har den här åtgärden ingen effekt.

readEntityState<T>(EntityId, TaskHubOptions)

Försöker läsa det aktuella tillståndet för en entitet. Returnerar odefinierat om entiteten inte finns eller om JSON-serialiserat tillstånd för entiteten är större än 16 KB.

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

Parametrar

entityId

EntityId

Målentiteten.

options

TaskHubOptions

valfritt objekt som tillhandahåller TaskHubName för målentiteten och namnet på dess associerade anslutningssträng

Returer

Promise<EntityStateResponse<T>>

Ett svar som innehåller den aktuella statusen för entiteten.

rewind(string, string, TaskHubOptions)

Spolar tillbaka den angivna misslyckade orkestreringsinstansen med en orsak.

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

Parametrar

instanceId

string

ID:t för orkestreringsinstansen för att spola tillbaka.

reason

string

Orsaken till att orkestreringsinstansen spolas tillbaka.

options

TaskHubOptions

objekt som tillhandahåller TaskHubName för orkestreringsinstansen och namnet på dess associerade anslutningssträng

Returer

Promise<void>

Ett löfte som löser när återspolningsmeddelandet visas.

Den här funktionen är för närvarande i förhandsversion.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Signalerar en entitet för att utföra en åtgärd.

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

Parametrar

entityId

EntityId

Målentiteten.

operationName

string

Namnet på åtgärden.

operationContent

unknown

Innehållet för åtgärden.

options

TaskHubOptions

objekt som tillhandahåller TaskHubName för entitetsinstansen och namnet på dess associerade anslutningssträng

Returer

Promise<void>

startNew(string, StartNewOptions)

Startar en ny instans av den angivna orchestrator-funktionen.

Om det redan finns en orkestreringsinstans med angivet ID ersätts den befintliga instansen tyst av den nya instansen.

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

Parametrar

orchestratorFunctionName

string

Namnet på orkestreringsfunktionen som ska startas.

options

StartNewOptions

valfritt objekt för att styra den schemalagda orkestratorn (t.ex. ange indata, instanceID)

Returer

Promise<string>

ID för den nya orkestreringsinstansen.

terminate(string, string)

Avslutar en orkestreringsinstans som körs.

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

Parametrar

instanceId

string

ID för orkestreringsinstansen som ska avslutas.

reason

string

Orsaken till att orkestreringsinstansen avslutas.

Returer

Promise<void>

Ett löfte som löser när meddelandet avslutas visas.

Att avsluta en orkestreringsinstans har ingen effekt på körning av aktivitetsfunktioner under flygning eller underorkestreringar som startades av den aktuella orkestreringsinstansen.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Skapar ett HTTP-svar som antingen innehåller en nyttolast med hanterings-URL:er för en icke-slutförd instans eller innehåller nyttolasten som innehåller utdata från den slutförda orkestreringen.

Om orkestreringen inte slutförs inom den angivna tidsgränsen är HTTP-svaret identiskt med createCheckStatusResponse().

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

Parametrar

request

HttpRequest

HTTP-begäran som utlöste den aktuella funktionen.

instanceId

string

Det unika ID för den instans som ska kontrolleras.

waitOptions

WaitForCompletionOptions

alternativobjekt som anger tidsgränserna för hur länge utdata ska vänta från den hållbara funktionen och hur ofta utdata ska sökas efter.

Returer

Promise<HttpResponse>