Class WorkflowMetadata

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

The name of the query to retrieve this information is __temporal_workflow_metadata.

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

Inheritance

object

WorkflowMetadata

Implements

IMessage<WorkflowMetadata>

IEquatable<WorkflowMetadata>

IDeepCloneable<WorkflowMetadata>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowMetadata()

public WorkflowMetadata()

WorkflowMetadata(WorkflowMetadata)

public WorkflowMetadata(WorkflowMetadata other)

Parameters

other WorkflowMetadata

Fields

CurrentDetailsFieldNumber

Field number for the "current_details" field.

public const int CurrentDetailsFieldNumber = 2

Field Value

int

DefinitionFieldNumber

Field number for the "definition" field.

public const int DefinitionFieldNumber = 1

Field Value

int

Properties

CurrentDetails

Current long-form details of the workflow's state. This is used by user interfaces to show long-form text. This text may be formatted by the user interface.

public string CurrentDetails { get; set; }

Property Value

string

Definition

Metadata provided at declaration or creation time.

public WorkflowDefinition Definition { get; set; }

Property Value

WorkflowDefinition

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<WorkflowMetadata> Parser { get; }

Property Value

MessageParser<WorkflowMetadata>

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 WorkflowMetadata Clone()

Returns

WorkflowMetadata

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(WorkflowMetadata)

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

public bool Equals(WorkflowMetadata other)

Parameters

other WorkflowMetadata

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(WorkflowMetadata)

Merges the given message into this one.

public void MergeFrom(WorkflowMetadata other)

Parameters

other WorkflowMetadata

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.