Class WorkflowTaskStartedEventAttributes

Namespace

Temporalio.Api.History.V1

Assembly

Temporalio.dll

public sealed class WorkflowTaskStartedEventAttributes : IMessage<WorkflowTaskStartedEventAttributes>, IEquatable<WorkflowTaskStartedEventAttributes>, IDeepCloneable<WorkflowTaskStartedEventAttributes>, IBufferMessage, IMessage

Inheritance

object

WorkflowTaskStartedEventAttributes

Implements

IMessage<WorkflowTaskStartedEventAttributes>

IEquatable<WorkflowTaskStartedEventAttributes>

IDeepCloneable<WorkflowTaskStartedEventAttributes>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowTaskStartedEventAttributes()

public WorkflowTaskStartedEventAttributes()

WorkflowTaskStartedEventAttributes(WorkflowTaskStartedEventAttributes)

public WorkflowTaskStartedEventAttributes(WorkflowTaskStartedEventAttributes other)

Parameters

other WorkflowTaskStartedEventAttributes

Fields

BuildIdRedirectCounterFieldNumber

Field number for the "build_id_redirect_counter" field.

public const int BuildIdRedirectCounterFieldNumber = 7

Field Value

int

HistorySizeBytesFieldNumber

Field number for the "history_size_bytes" field.

public const int HistorySizeBytesFieldNumber = 5

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 2

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 3

Field Value

int

ScheduledEventIdFieldNumber

Field number for the "scheduled_event_id" field.

public const int ScheduledEventIdFieldNumber = 1

Field Value

int

SuggestContinueAsNewFieldNumber

Field number for the "suggest_continue_as_new" field.

public const int SuggestContinueAsNewFieldNumber = 4

Field Value

int

WorkerVersionFieldNumber

Field number for the "worker_version" field.

public const int WorkerVersionFieldNumber = 6

Field Value

int

Properties

BuildIdRedirectCounter

Used by server internally to properly reapply build ID redirects to an execution when rebuilding it from events. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

[Obsolete]
public long BuildIdRedirectCounter { get; set; }

Property Value

long

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HistorySizeBytes

Total history size in bytes, which the workflow might use to decide when to continue-as-new regardless of the suggestion. Note that history event count is just the event id of this event, so we don't include it explicitly here.

public long HistorySizeBytes { get; set; }

Property Value

long

Identity

Identity of the worker who picked up this task

public string Identity { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowTaskStartedEventAttributes> Parser { get; }

Property Value

MessageParser<WorkflowTaskStartedEventAttributes>

RequestId

TODO: ? Appears unused?

public string RequestId { get; set; }

Property Value

string

ScheduledEventId

The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to

public long ScheduledEventId { get; set; }

Property Value

long

SuggestContinueAsNew

True if this workflow should continue-as-new soon because its history size (in either event count or bytes) is getting large.

public bool SuggestContinueAsNew { get; set; }

Property Value

bool

WorkerVersion

Version info of the worker to whom this task was dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

[Obsolete]
public WorkerVersionStamp WorkerVersion { get; set; }

Property Value

WorkerVersionStamp

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public WorkflowTaskStartedEventAttributes Clone()

Returns

WorkflowTaskStartedEventAttributes

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(WorkflowTaskStartedEventAttributes)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(WorkflowTaskStartedEventAttributes other)

Parameters

other WorkflowTaskStartedEventAttributes

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(WorkflowTaskStartedEventAttributes)

Merges the given message into this one.

public void MergeFrom(WorkflowTaskStartedEventAttributes other)

Parameters

other WorkflowTaskStartedEventAttributes

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.