DurableClient class

패키지:

durable-functions

오케스트레이션 및 엔터티 인스턴스에 이벤트를 시작, 쿼리, 종료 및 발생시키는 클라이언트입니다.

속성

taskHubName

이 오케스트레이션 클라이언트 인스턴스에 구성된 작업 허브의 이름입니다.

메서드

createCheckStatusResponse(undefined | HttpRequest, string)	지정된 인스턴스의 상태를 확인하는 데 유용한 HTTP 응답을 만듭니다.
createHttpManagementPayload(string)	인스턴스 관리 HTTP 엔드포인트가 포함된 HttpManagementPayload 개체를 만듭니다.
getStatus(string, GetStatusOptions)	지정된 오케스트레이션 인스턴스의 상태를 가져옵니다.
getStatusAll()	모든 오케스트레이션 인스턴스의 상태를 가져옵니다.
getStatusBy(OrchestrationFilter)	지정된 조건과 일치하는 모든 오케스트레이션 인스턴스의 상태를 가져옵니다.
purgeInstanceHistory(string)	특정 오케스트레이션 인스턴스의 기록을 제거합니다.
purgeInstanceHistoryBy(OrchestrationFilter)	조건과 일치하는 인스턴스의 오케스트레이션 기록을 제거합니다.
raiseEvent(string, string, unknown, TaskHubOptions)	대기 중인 오케스트레이션 인스턴스에 이벤트 알림 메시지를 보냅니다.
readEntityState<T>(EntityId, TaskHubOptions)	엔터티의 현재 상태를 읽으려고 시도합니다. 엔터티가 없거나 엔터티의 JSON 직렬화된 상태가 16KB보다 큰 경우 정의되지 않은 값을 반환합니다.
rewind(string, string, TaskHubOptions)	지정된 실패한 오케스트레이션 인스턴스를 원인으로 되감습니다.
signalEntity(EntityId, string, unknown, TaskHubOptions)	엔터티에 작업을 수행하도록 신호를 전송합니다.
startNew(string, StartNewOptions)	지정된 오케스트레이터 함수의 새 인스턴스를 시작합니다. 지정된 ID를 가진 오케스트레이션 인스턴스가 이미 있는 경우 기존 인스턴스는 이 새 인스턴스로 자동으로 대체됩니다.
terminate(string, string)	실행 중인 오케스트레이션 인스턴스를 종료합니다.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	완료되지 않은 인스턴스에 대한 관리 URL의 페이로드를 포함하거나 완료된 오케스트레이션의 출력을 포함하는 페이로드를 포함하는 HTTP 응답을 만듭니다. 지정된 시간 제한 내에 오케스트레이션이 완료되지 않으면 HTTP 응답은 createCheckStatusResponse()의 응답과 동일합니다.

속성 세부 정보

taskHubName

이 오케스트레이션 클라이언트 인스턴스에 구성된 작업 허브의 이름입니다.

taskHubName: string

속성 값

string

메서드 세부 정보

createCheckStatusResponse(undefined | HttpRequest, string)

지정된 인스턴스의 상태를 확인하는 데 유용한 HTTP 응답을 만듭니다.

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

매개 변수

request

undefined | HttpRequest

현재 오케스트레이션 인스턴스를 트리거한 HTTP 요청입니다.

instanceId

string

확인할 오케스트레이션 인스턴스의 ID입니다.

반환

HttpResponse

위치 헤더와 인스턴스 관리 URL이 포함된 페이로드가 있는 HTTP 202 응답입니다.

createHttpManagementPayload(string)

인스턴스 관리 HTTP 엔드포인트가 포함된 HttpManagementPayload 개체를 만듭니다.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

매개 변수

instanceId

string

확인할 오케스트레이션 인스턴스의 ID입니다.

반환

HttpManagementPayload

getStatus(string, GetStatusOptions)

지정된 오케스트레이션 인스턴스의 상태를 가져옵니다.

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

매개 변수

instanceId

string

쿼리할 오케스트레이션 인스턴스의 ID입니다.

options

GetStatusOptions

추가 구성을 지정하는 options 개체

반환

Promise<DurableOrchestrationStatus>

getStatusAll()

모든 오케스트레이션 인스턴스의 상태를 가져옵니다.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

반환

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

지정된 조건과 일치하는 모든 오케스트레이션 인스턴스의 상태를 가져옵니다.

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

매개 변수

filter

OrchestrationFilter

검색할 오케스트레이션을 지정하는 OrchestrationFilter 개체입니다.

반환

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

특정 오케스트레이션 인스턴스의 기록을 제거합니다.

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

매개 변수

instanceId

string

제거할 오케스트레이션 인스턴스의 ID입니다.

반환

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

조건과 일치하는 인스턴스의 오케스트레이션 기록을 제거합니다.

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

매개 변수

filter

OrchestrationFilter

제거할 오케스트레이션을 지정하는 OrchestrationFilter 개체입니다.

반환

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

대기 중인 오케스트레이션 인스턴스에 이벤트 알림 메시지를 보냅니다.

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

매개 변수

instanceId

string

이벤트를 처리할 오케스트레이션 인스턴스의 ID입니다.

eventName

string

이벤트의 이름입니다.

eventData

unknown

이벤트와 연결된 JSON 직렬화 가능 데이터입니다.

options

TaskHubOptions

오케스트레이션 인스턴스의 TaskHubName 및 연결된 연결 문자열의 이름을 제공하는 개체

반환

Promise<void>

이벤트 알림 메시지가 큐에 삽입된 시기를 확인하는 약속입니다.

이벤트를 처리하려면 대상 오케스트레이션 인스턴스가 eventName사용하여 waitForExternalEvent(string) 이벤트를 대기해야 합니다.

지정된 인스턴스를 찾을 수 없거나 실행하지 않으면 이 작업이 적용되지 않습니다.

readEntityState<T>(EntityId, TaskHubOptions)

엔터티의 현재 상태를 읽으려고 시도합니다. 엔터티가 없거나 엔터티의 JSON 직렬화된 상태가 16KB보다 큰 경우 정의되지 않은 값을 반환합니다.

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

매개 변수

entityId

EntityId

대상 엔터티입니다.

options

TaskHubOptions

대상 엔터티의 TaskHubName 및 연결된 연결 문자열의 이름을 제공하는 선택적 개체

반환

Promise<EntityStateResponse<T>>

엔터티의 현재 상태를 포함하는 응답입니다.

rewind(string, string, TaskHubOptions)

지정된 실패한 오케스트레이션 인스턴스를 원인으로 되감습니다.

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

매개 변수

instanceId

string

되감을 오케스트레이션 인스턴스의 ID입니다.

reason

string

오케스트레이션 인스턴스를 되감는 이유입니다.

options

TaskHubOptions

오케스트레이션 인스턴스의 TaskHubName 및 연결된 연결 문자열의 이름을 제공하는 개체

반환

Promise<void>

되감기 메시지가 큐에 삽입될 때 해결되는 약속입니다.

이 기능은 현재 미리 보기로 제공됩니다.

signalEntity(EntityId, string, unknown, TaskHubOptions)

엔터티에 작업을 수행하도록 신호를 전송합니다.

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

매개 변수

entityId

EntityId

대상 엔터티입니다.

operationName

string

작업의 이름입니다.

operationContent

unknown

작업의 콘텐츠입니다.

options

TaskHubOptions

엔터티 인스턴스의 TaskHubName 및 연결된 연결 문자열의 이름을 제공하는 개체

반환

Promise<void>

startNew(string, StartNewOptions)

지정된 오케스트레이터 함수의 새 인스턴스를 시작합니다.

지정된 ID를 가진 오케스트레이션 인스턴스가 이미 있는 경우 기존 인스턴스는 이 새 인스턴스로 자동으로 대체됩니다.

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

매개 변수

orchestratorFunctionName

string

시작할 오케스트레이터 함수의 이름입니다.

options

StartNewOptions

예약된 오케스트레이터를 제어하는 선택적 개체(예: 입력 제공, instanceID)

반환

Promise<string>

새 오케스트레이션 인스턴스의 ID입니다.

terminate(string, string)

실행 중인 오케스트레이션 인스턴스를 종료합니다.

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

매개 변수

instanceId

string

종료할 오케스트레이션 인스턴스의 ID입니다.

reason

string

오케스트레이션 인스턴스를 종료하는 이유입니다.

반환

Promise<void>

종료 메시지가 큐에 삽입될 때 해결되는 약속입니다.

오케스트레이션 인스턴스를 종료해도 현재 오케스트레이션 인스턴스에서 시작한 진행 중인 작업 함수 실행 또는 하위 오케스트레이션에는 영향을 주지 않습니다.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

완료되지 않은 인스턴스에 대한 관리 URL의 페이로드를 포함하거나 완료된 오케스트레이션의 출력을 포함하는 페이로드를 포함하는 HTTP 응답을 만듭니다.

지정된 시간 제한 내에 오케스트레이션이 완료되지 않으면 HTTP 응답은 createCheckStatusResponse()의 응답과 동일합니다.

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

매개 변수

request

HttpRequest

현재 함수를 트리거한 HTTP 요청입니다.

instanceId

string

확인할 인스턴스의 고유 ID입니다.

waitOptions

WaitForCompletionOptions

지속성 함수에서 출력을 기다리는 시간 및 출력을 확인하는 빈도에 대한 시간 제한을 지정하는 options 개체입니다.

반환

Promise<HttpResponse>