DurableClient class

Pakket:

durable-functions

Client voor het starten, opvragen, beëindigen en genereren van gebeurtenissen voor indeling en entiteitsexemplaren.

Eigenschappen

taskHubName

De naam van de taakhub die is geconfigureerd op dit orchestration-clientexemplaar.

Methoden

createCheckStatusResponse(undefined | HttpRequest, string)	Hiermee maakt u een HTTP-antwoord dat handig is voor het controleren van de status van het opgegeven exemplaar.
createHttpManagementPayload(string)	Hiermee maakt u een HttpManagementPayload--object dat HTTP-eindpunten voor exemplaarbeheer bevat.
getStatus(string, GetStatusOptions)	Hiermee haalt u de status van het opgegeven indelingsexemplaar op.
getStatusAll()	Hiermee haalt u de status van alle indelingsexemplaren op.
getStatusBy(OrchestrationFilter)	Hiermee haalt u de status op van alle indelingsexemplaren die overeenkomen met de opgegeven voorwaarden.
purgeInstanceHistory(string)	Verwijder de geschiedenis voor een specifiek indelingsexemplaar.
purgeInstanceHistoryBy(OrchestrationFilter)	Verwijder de indelingsgeschiedenis voor exemplaren die overeenkomen met de voorwaarden.
raiseEvent(string, string, unknown, TaskHubOptions)	Hiermee wordt een bericht over een gebeurtenismelding verzonden naar een instantie van wachtindeling.
readEntityState<T>(EntityId, TaskHubOptions)	Probeert de huidige status van een entiteit te lezen. Retourneert niet-gedefinieerd als de entiteit niet bestaat of als de JSON-geserialiseerde status van de entiteit groter is dan 16 kB.
rewind(string, string, TaskHubOptions)	Hiermee wordt het opgegeven mislukte indelingsexemplaar terugspoelen met een reden.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Geeft een entiteit aan om een bewerking uit te voeren.
startNew(string, StartNewOptions)	Hiermee start u een nieuw exemplaar van de opgegeven orchestratorfunctie. Als er al een indelingsexemplaar met de opgegeven id bestaat, wordt het bestaande exemplaar op de achtergrond vervangen door dit nieuwe exemplaar.
terminate(string, string)	Hiermee wordt een actief orchestration-exemplaar beëindigd.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Hiermee maakt u een HTTP-antwoord dat een nettolading van beheer-URL's voor een niet-voltooid exemplaar bevat of de nettolading bevat die de uitvoer van de voltooide indeling bevat. Als de indeling niet binnen de opgegeven time-out wordt voltooid, is het HTTP-antwoord identiek aan die van createCheckStatusResponse().

Eigenschapdetails

taskHubName

De naam van de taakhub die is geconfigureerd op dit orchestration-clientexemplaar.

taskHubName: string

Waarde van eigenschap

string

Methodedetails

createCheckStatusResponse(undefined | HttpRequest, string)

Hiermee maakt u een HTTP-antwoord dat handig is voor het controleren van de status van het opgegeven exemplaar.

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

Parameters

request

undefined | HttpRequest

De HTTP-aanvraag die het huidige indelingsexemplaar heeft geactiveerd.

instanceId

string

De id van het orchestration-exemplaar dat moet worden gecontroleerd.

Retouren

HttpResponse

Een HTTP 202-antwoord met een locatieheader en een nettolading met URL's voor exemplaarbeheer.

createHttpManagementPayload(string)

Hiermee maakt u een HttpManagementPayload--object dat HTTP-eindpunten voor exemplaarbeheer bevat.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parameters

instanceId

string

De id van het orchestration-exemplaar dat moet worden gecontroleerd.

Retouren

HttpManagementPayload

getStatus(string, GetStatusOptions)

Hiermee haalt u de status van het opgegeven indelingsexemplaar op.

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

Parameters

instanceId

string

De id van het indelingsexemplaar om een query uit te voeren.

options

GetStatusOptions

optiesobject waarin extra configuratie wordt opgegeven

Retouren

Promise<DurableOrchestrationStatus>

getStatusAll()

Hiermee haalt u de status van alle indelingsexemplaren op.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Retouren

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Hiermee haalt u de status op van alle indelingsexemplaren die overeenkomen met de opgegeven voorwaarden.

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

Parameters

filter

OrchestrationFilter

het OrchestrationFilter-object waarmee wordt opgegeven welke indelingen moeten worden opgehaald.

Retouren

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Verwijder de geschiedenis voor een specifiek indelingsexemplaar.

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

Parameters

instanceId

string

De id van het indelingsexemplaar dat moet worden leeggeschoond.

Retouren

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Verwijder de indelingsgeschiedenis voor exemplaren die overeenkomen met de voorwaarden.

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

Parameters

filter

OrchestrationFilter

het OrchestrationFilter-object waarmee wordt opgegeven welke indelingen moeten worden verwijderd.

Retouren

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Hiermee wordt een bericht over een gebeurtenismelding verzonden naar een instantie van wachtindeling.

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

Parameters

instanceId

string

De id van het indelingsexemplaar waarmee de gebeurtenis wordt verwerkt.

eventName

string

De naam van de gebeurtenis.

eventData

unknown

De JSON-serialiseerbare gegevens die aan de gebeurtenis zijn gekoppeld.

options

TaskHubOptions

object dat TaskHubName opgeeft van het orchestration-exemplaar en de naam van de bijbehorende verbindingsreeks

Retouren

Promise<void>

Een belofte die wordt opgelost wanneer het bericht van de gebeurtenismelding is geïnventueerd.

Als u de gebeurtenis wilt afhandelen, moet het doelindelingexemplaar wachten op een gebeurtenis met de naam eventName met behulp van waitForExternalEvent(string).

Als het opgegeven exemplaar niet wordt gevonden of niet wordt uitgevoerd, heeft deze bewerking geen effect.

readEntityState<T>(EntityId, TaskHubOptions)

Probeert de huidige status van een entiteit te lezen. Retourneert niet-gedefinieerd als de entiteit niet bestaat of als de JSON-geserialiseerde status van de entiteit groter is dan 16 kB.

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

Parameters

entityId

EntityId

De doelentiteit.

options

TaskHubOptions

optioneel object dat de TaskHubName van de doelentiteit en de naam van de bijbehorende verbindingsreeks opgeeft

Retouren

Promise<EntityStateResponse<T>>

Een antwoord met de huidige status van de entiteit.

rewind(string, string, TaskHubOptions)

Hiermee wordt het opgegeven mislukte indelingsexemplaar terugspoelen met een reden.

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

Parameters

instanceId

string

De id van het indelingsexemplaar om terug te spoelen.

reason

string

De reden voor het terugspoelen van het orchestration-exemplaar.

options

TaskHubOptions

object dat TaskHubName opgeeft van het orchestration-exemplaar en de naam van de bijbehorende verbindingsreeks

Retouren

Promise<void>

Een belofte die wordt opgelost wanneer het terugspoelen van het bericht wordt gespoeld.

Deze functie is momenteel beschikbaar als preview-versie.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Geeft een entiteit aan om een bewerking uit te voeren.

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

Parameters

entityId

EntityId

De doelentiteit.

operationName

string

De naam van de bewerking.

operationContent

unknown

De inhoud voor de bewerking.

options

TaskHubOptions

object dat TaskHubName opgeeft van het entiteitsexemplaar en de naam van de bijbehorende verbindingsreeks

Retouren

Promise<void>

startNew(string, StartNewOptions)

Hiermee start u een nieuw exemplaar van de opgegeven orchestratorfunctie.

Als er al een indelingsexemplaar met de opgegeven id bestaat, wordt het bestaande exemplaar op de achtergrond vervangen door dit nieuwe exemplaar.

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

Parameters

orchestratorFunctionName

string

De naam van de orchestratorfunctie die moet worden gestart.

options

StartNewOptions

optioneel object om de geplande orchestrator te beheren (bijvoorbeeld invoer, instanceID opgeven)

Retouren

Promise<string>

De id van het nieuwe indelingsexemplaar.

terminate(string, string)

Hiermee wordt een actief orchestration-exemplaar beëindigd.

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

Parameters

instanceId

string

De id van het indelingsexemplaar dat moet worden beëindigd.

reason

string

De reden voor het beëindigen van het indelingsexemplaar.

Retouren

Promise<void>

Een belofte die wordt opgelost wanneer het beëindigingsbericht wordt beëindigd.

Het beëindigen van een indelingsexemplaar heeft geen invloed op uitvoeringen van in-flight-activiteitsfuncties of subindelingen die zijn gestart door het huidige indelingsexemplaar.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Hiermee maakt u een HTTP-antwoord dat een nettolading van beheer-URL's voor een niet-voltooid exemplaar bevat of de nettolading bevat die de uitvoer van de voltooide indeling bevat.

Als de indeling niet binnen de opgegeven time-out wordt voltooid, is het HTTP-antwoord identiek aan die van createCheckStatusResponse().

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

Parameters

request

HttpRequest

De HTTP-aanvraag die de huidige functie heeft geactiveerd.

instanceId

string

De unieke id van het exemplaar dat moet worden gecontroleerd.

waitOptions

WaitForCompletionOptions

optiesobject waarin de time-outs worden opgegeven voor hoe lang moet worden gewacht op uitvoer van de duurzame functie en hoe vaak moet worden gecontroleerd op uitvoer.

Retouren

Promise<HttpResponse>