Class ActivityExecutionDescription

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Description of a standalone activity execution from a describe call.

public class ActivityExecutionDescription : ActivityExecution

Inheritance

object

ActivityExecution

ActivityExecutionDescription

Inherited Members

ActivityExecution.ActivityId

ActivityExecution.ActivityRunId

ActivityExecution.ActivityType

ActivityExecution.CloseTime

ActivityExecution.ExecutionDuration

ActivityExecution.Namespace

ActivityExecution.ScheduledTime

ActivityExecution.StateTransitionCount

ActivityExecution.Status

ActivityExecution.TaskQueue

ActivityExecution.TypedSearchAttributes

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Standalone activities are experimental.

Constructors

ActivityExecutionDescription(DescribeActivityExecutionResponse, string, DataConverter)

Initializes a new instance of the ActivityExecutionDescription class.

protected ActivityExecutionDescription(DescribeActivityExecutionResponse rawDescription, string clientNamespace, DataConverter dataConverter)

Parameters

rawDescription DescribeActivityExecutionResponse

Raw proto description.

clientNamespace string

Client namespace.

dataConverter DataConverter

Data converter.

Remarks

WARNING: This constructor may be mutated in backwards incompatible ways.

Properties

Attempt

Gets the current attempt number, starting at 1.

public int Attempt { get; }

Property Value

int

CanceledReason

Gets the reason for cancellation, if cancel was requested.

public string? CanceledReason { get; }

Property Value

string

CurrentRetryInterval

Gets the time until the next retry, if applicable.

public TimeSpan? CurrentRetryInterval { get; }

Property Value

TimeSpan?

ExpirationTime

Gets the scheduled time plus schedule-to-close timeout.

public DateTime? ExpirationTime { get; }

Property Value

DateTime?

HeartbeatTimeout

Gets the heartbeat timeout.

public TimeSpan? HeartbeatTimeout { get; }

Property Value

TimeSpan?

LastAttemptCompleteTime

Gets when the last attempt completed.

public DateTime? LastAttemptCompleteTime { get; }

Property Value

DateTime?

LastHeartbeatTime

Gets the time of the last heartbeat.

public DateTime? LastHeartbeatTime { get; }

Property Value

DateTime?

LastStartedTime

Gets when the last attempt was started.

public DateTime? LastStartedTime { get; }

Property Value

DateTime?

LastWorkerIdentity

Gets the identity of the last worker that processed the activity.

public string? LastWorkerIdentity { get; }

Property Value

string

LongPollToken

Gets the token for follow-on long-poll requests, or null if the activity is complete.

public byte[]? LongPollToken { get; }

Property Value

byte[]

NextAttemptScheduleTime

Gets when the next attempt will be scheduled.

public DateTime? NextAttemptScheduleTime { get; }

Property Value

DateTime?

RetryPolicy

Gets the retry policy for the activity.

public RetryPolicy? RetryPolicy { get; }

Property Value

RetryPolicy

RunState

Gets the more detailed run state if the activity status is running.

public PendingActivityState RunState { get; }

Property Value

PendingActivityState

ScheduleToCloseTimeout

Gets the schedule-to-close timeout.

public TimeSpan? ScheduleToCloseTimeout { get; }

Property Value

TimeSpan?

ScheduleToStartTimeout

Gets the schedule-to-start timeout.

public TimeSpan? ScheduleToStartTimeout { get; }

Property Value

TimeSpan?

StartToCloseTimeout

Gets the start-to-close timeout.

public TimeSpan? StartToCloseTimeout { get; }

Property Value

TimeSpan?

Methods

GetStaticDetailsAsync()

Gets the general fixed details for this activity execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

public Task<string?> GetStaticDetailsAsync()

Returns

Task<string>

Static details.

Remarks

WARNING: Standalone activities are experimental.

GetStaticSummaryAsync()

Gets the single-line fixed summary for this activity execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

public Task<string?> GetStaticSummaryAsync()

Returns

Task<string>

Static summary.

Remarks

WARNING: Standalone activities are experimental.