TaskOrchestrationContext.SetCustomStatus(Object) Method

Reference

Definition

Namespace:: Microsoft.DurableTask

Assembly:: Microsoft.DurableTask.Abstractions.dll

Package:: Microsoft.DurableTask.Abstractions v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Assigns a custom status value to the current orchestration.

public abstract void SetCustomStatus (object? customStatus);

abstract member SetCustomStatus : obj -> unit

Public MustOverride Sub SetCustomStatus (customStatus As Object)

Parameters

customStatus: Object

A serializable value to assign as the custom status value or null to clear the custom status.

Exceptions

InvalidOperationException

Thrown if the calling thread is anything other than the main orchestrator thread.

Remarks

The customStatus value is serialized and stored in orchestration state and will be made available to the orchestration status query APIs. The serialized value must not exceed 16 KB of UTF-16 encoded text.

Applies to

Compartilhar via