OrchestrationMetadata Class

Definition

Namespace:

Microsoft.DurableTask.Client

Assembly:

Microsoft.DurableTask.Client.dll

Package:

Microsoft.DurableTask.Client v1.0.0

Represents a snapshot of an orchestration instance's current state, including metadata.

public sealed class OrchestrationMetadata

type OrchestrationMetadata = class

Public NotInheritable Class OrchestrationMetadata

Inheritance

Object

OrchestrationMetadata

Remarks

Instances of this class are produced by methods in the DurableTaskClient class, such as GetInstancesAsync(String, CancellationToken), WaitForInstanceStartAsync(String, CancellationToken) and WaitForInstanceCompletionAsync(String, CancellationToken).

Constructors

OrchestrationMetadata(String, String)

Initializes a new instance of the OrchestrationMetadata class.

Properties

CreatedAt	Gets the orchestration instance's creation time in UTC.
DataConverter	Gets the data converter used to deserialized the serialized data on this instance. This will only be present when inputs and outputs are requested, null otherwise.
FailureDetails	Gets the failure details, if any, for the orchestration instance.
InstanceId	Gets the unique ID of the orchestration instance.
IsCompleted	Gets a value indicating whether the orchestration instance was completed at the time this object was fetched.
IsRunning	Gets a value indicating whether the orchestration instance was running at the time this object was fetched.
LastUpdatedAt	Gets the orchestration instance's last updated time in UTC.
Name	Gets the name of the orchestration.
RuntimeStatus	Gets the current runtime status of the orchestration instance at the time this object was fetched.
SerializedCustomStatus	Gets the orchestration instance's serialized custom status, if any, as a string value.
SerializedInput	Gets the orchestration instance's serialized input, if any, as a string value.
SerializedOutput	Gets the orchestration instance's serialized output, if any, as a string value.

Methods

ReadCustomStatusAs<T>()	Deserializes the orchestration's custom status value into an object of the specified type.
ReadInputAs<T>()	Deserializes the orchestration's input into an object of the specified type.
ReadOutputAs<T>()	Deserializes the orchestration's output into an object of the specified type.
ToString()	Generates a user-friendly string representation of the current metadata object.