DurableClient class

Paket:

durable-functions

Olayları başlatmak, sorgulamak, sonlandırmak ve düzenleme ve varlık örneklerine yükseltmek için istemci.

Özellikler

taskHubName

Bu düzenleme istemci örneğinde yapılandırılan görev hub'ının adı.

Yöntemler

createCheckStatusResponse(undefined | HttpRequest, string)	Belirtilen örneğin durumunu denetlemek için yararlı olan bir HTTP yanıtı oluşturur.
createHttpManagementPayload(string)	Örnek yönetimi HTTP uç noktalarını içeren bir HttpManagementPayload nesnesi oluşturur.
getStatus(string, GetStatusOptions)	Belirtilen düzenleme örneğinin durumunu alır.
getStatusAll()	Tüm düzenleme örneklerinin durumunu alır.
getStatusBy(OrchestrationFilter)	Belirtilen koşullarla eşleşen tüm düzenleme örneklerinin durumunu alır.
purgeInstanceHistory(string)	Belirli bir düzenleme örneğinin geçmişini temizleme.
purgeInstanceHistoryBy(OrchestrationFilter)	Koşullarla eşleşen örnekler için düzenleme geçmişini temizleme.
raiseEvent(string, string, unknown, TaskHubOptions)	Bekleyen düzenleme örneğine bir olay bildirim iletisi gönderir.
readEntityState<T>(EntityId, TaskHubOptions)	Bir varlığın geçerli durumunu okumaya çalışır. Varlık yoksa veya varlığın JSON serileştirilmiş durumu 16 KB'tan büyükse tanımsız döndürür.
rewind(string, string, TaskHubOptions)	Belirtilen başarısız düzenleme örneğini bir nedenle geri sarmalar.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Bir işlemi gerçekleştirmek için bir varlığa sinyal gönderir.
startNew(string, StartNewOptions)	Belirtilen orchestrator işlevinin yeni bir örneğini başlatır. Belirtilen kimlikle bir düzenleme örneği zaten varsa, mevcut örnek sessizce bu yeni örnekle değiştirilir.
terminate(string, string)	Çalışan bir düzenleme örneğini sonlandırır.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Tamamlanmamış bir örneğin yönetim URL'lerinin yükünü içeren veya tamamlanan düzenlemenin çıkışını içeren yükü içeren bir HTTP yanıtı oluşturur. Düzenleme belirtilen zaman aşımı içinde tamamlanmazsa, HTTP yanıtı createCheckStatusResponse() ile aynı olacaktır.

Özellik Ayrıntıları

taskHubName

Bu düzenleme istemci örneğinde yapılandırılan görev hub'ının adı.

taskHubName: string

Özellik Değeri

string

Yöntem Ayrıntıları

createCheckStatusResponse(undefined | HttpRequest, string)

Belirtilen örneğin durumunu denetlemek için yararlı olan bir HTTP yanıtı oluşturur.

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

Parametreler

request

undefined | HttpRequest

Geçerli düzenleme örneğini tetikleyen HTTP isteği.

instanceId

string

Denetlenecek düzenleme örneğinin kimliği.

Döndürülenler

HttpResponse

Konum üst bilgisi ve örnek yönetimi URL'lerini içeren yük içeren bir HTTP 202 yanıtı.

createHttpManagementPayload(string)

Örnek yönetimi HTTP uç noktalarını içeren bir HttpManagementPayload nesnesi oluşturur.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parametreler

instanceId

string

Denetlenecek düzenleme örneğinin kimliği.

Döndürülenler

HttpManagementPayload

getStatus(string, GetStatusOptions)

Belirtilen düzenleme örneğinin durumunu alır.

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

Parametreler

instanceId

string

Sorgu için düzenleme örneğinin kimliği.

options

GetStatusOptions

ek yapılandırmayı belirten options nesnesi

Döndürülenler

Promise<DurableOrchestrationStatus>

getStatusAll()

Tüm düzenleme örneklerinin durumunu alır.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Döndürülenler

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Belirtilen koşullarla eşleşen tüm düzenleme örneklerinin durumunu alır.

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

Parametreler

filter

OrchestrationFilter

hangi düzenlemelerin alınacağını belirten OrchestrationFilter nesnesi.

Döndürülenler

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Belirli bir düzenleme örneğinin geçmişini temizleme.

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

Parametreler

instanceId

string

Temizlenir düzenleme örneğinin kimliği.

Döndürülenler

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Koşullarla eşleşen örnekler için düzenleme geçmişini temizleme.

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

Parametreler

filter

OrchestrationFilter

Hangi düzenlemelerin temizleneceğini belirten OrchestrationFilter nesnesi.

Döndürülenler

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Bekleyen düzenleme örneğine bir olay bildirim iletisi gönderir.

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

Parametreler

instanceId

string

Olayı işleyecek düzenleme örneğinin kimliği.

eventName

string

Olayın adı.

eventData

unknown

Olayla ilişkili JSON seri hale getirilebilir veriler.

options

TaskHubOptions

düzenleme örneğinin TaskHubName değerini ve ilişkili bağlantı dizesinin adını sağlayan nesne

Döndürülenler

Promise<void>

Olay bildirimi iletisinin ne zaman sıralandığını çözen bir söz.

Olayı işlemek için hedef düzenleme örneğinin eventNamekullanarak waitForExternalEvent(string) adlı bir olayı beklemesi gerekir.

Belirtilen örnek bulunamaz veya çalışmazsa, bu işlemin hiçbir etkisi olmaz.

readEntityState<T>(EntityId, TaskHubOptions)

Bir varlığın geçerli durumunu okumaya çalışır. Varlık yoksa veya varlığın JSON serileştirilmiş durumu 16 KB'tan büyükse tanımsız döndürür.

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

Parametreler

entityId

EntityId

Hedef varlık.

options

TaskHubOptions

hedef varlığın TaskHubName değerini ve ilişkili bağlantı dizesinin adını sağlayan isteğe bağlı nesne

Döndürülenler

Promise<EntityStateResponse<T>>

Varlığın geçerli durumunu içeren bir yanıt.

rewind(string, string, TaskHubOptions)

Belirtilen başarısız düzenleme örneğini bir nedenle geri sarmalar.

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

Parametreler

instanceId

string

Geri sarmak için düzenleme örneğinin kimliği.

reason

string

Düzenleme örneğini geri sarmanın nedeni.

options

TaskHubOptions

düzenleme örneğinin TaskHubName değerini ve ilişkili bağlantı dizesinin adını sağlayan nesne

Döndürülenler

Promise<void>

Geri sarma iletisi sıraya alındığında çözülen bir söz.

Bu özellik şu anda önizleme aşamasındadır.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Bir işlemi gerçekleştirmek için bir varlığa sinyal gönderir.

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

Parametreler

entityId

EntityId

Hedef varlık.

operationName

string

İşlemin adı.

operationContent

unknown

İşlemin içeriği.

options

TaskHubOptions

varlık örneğinin TaskHubName değerini ve ilişkili bağlantı dizesinin adını sağlayan nesne

Döndürülenler

Promise<void>

startNew(string, StartNewOptions)

Belirtilen orchestrator işlevinin yeni bir örneğini başlatır.

Belirtilen kimlikle bir düzenleme örneği zaten varsa, mevcut örnek sessizce bu yeni örnekle değiştirilir.

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

Parametreler

orchestratorFunctionName

string

Başlatacak orchestrator işlevinin adı.

options

StartNewOptions

zamanlanmış düzenleyiciyi denetlemek için isteğe bağlı nesne (örn. giriş, instanceID sağlama)

Döndürülenler

Promise<string>

Yeni düzenleme örneğinin kimliği.

terminate(string, string)

Çalışan bir düzenleme örneğini sonlandırır.

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

Parametreler

instanceId

string

Sonlandıracak düzenleme örneğinin kimliği.

reason

string

Düzenleme örneğini sonlandırmanın nedeni.

Döndürülenler

Promise<void>

Sonlandırma iletisi sıraya alındığında çözülen bir söz.

Düzenleme örneğini sonlandırmanın, geçerli düzenleme örneği tarafından başlatılan uçuş içi etkinlik işlevi yürütmeleri veya alt düzenlemeleri üzerinde hiçbir etkisi yoktur.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Tamamlanmamış bir örneğin yönetim URL'lerinin yükünü içeren veya tamamlanan düzenlemenin çıkışını içeren yükü içeren bir HTTP yanıtı oluşturur.

Düzenleme belirtilen zaman aşımı içinde tamamlanmazsa, HTTP yanıtı createCheckStatusResponse() ile aynı olacaktır.

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

Parametreler

request

HttpRequest

Geçerli işlevi tetikleyen HTTP isteği.

instanceId

string

Denetlenecek örneğin benzersiz kimliği.

waitOptions

WaitForCompletionOptions

options nesnesi, dayanıklı işlevden çıkışın ne kadar süreyle bekleneceğini ve çıkışın ne sıklıkta denetleneceğini belirten zaman aşımlarını belirtir.

Döndürülenler

Promise<HttpResponse>