Class WorkflowDefinition

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

(-- api-linter: core::0203::optional=disabled --)

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

Inheritance

object

WorkflowDefinition

Implements

IMessage<WorkflowDefinition>

IEquatable<WorkflowDefinition>

IDeepCloneable<WorkflowDefinition>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowDefinition()

public WorkflowDefinition()

WorkflowDefinition(WorkflowDefinition)

public WorkflowDefinition(WorkflowDefinition other)

Parameters

other WorkflowDefinition

Fields

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 2

Field Value

int

QueryDefinitionsFieldNumber

Field number for the "query_definitions" field.

public const int QueryDefinitionsFieldNumber = 3

Field Value

int

SignalDefinitionsFieldNumber

Field number for the "signal_definitions" field.

public const int SignalDefinitionsFieldNumber = 4

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 1

Field Value

int

UpdateDefinitionsFieldNumber

Field number for the "update_definitions" field.

public const int UpdateDefinitionsFieldNumber = 5

Field Value

int

Properties

Description

An optional workflow description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.

public string Description { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<WorkflowDefinition> Parser { get; }

Property Value

MessageParser<WorkflowDefinition>

QueryDefinitions

public RepeatedField<WorkflowInteractionDefinition> QueryDefinitions { get; }

Property Value

RepeatedField<WorkflowInteractionDefinition>

SignalDefinitions

public RepeatedField<WorkflowInteractionDefinition> SignalDefinitions { get; }

Property Value

RepeatedField<WorkflowInteractionDefinition>

Type

A name scoped by the task queue that maps to this workflow definition. If missing, this workflow is a dynamic workflow.

public string Type { get; set; }

Property Value

string

UpdateDefinitions

public RepeatedField<WorkflowInteractionDefinition> UpdateDefinitions { get; }

Property Value

RepeatedField<WorkflowInteractionDefinition>

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

Returns

WorkflowDefinition

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

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

public bool Equals(WorkflowDefinition other)

Parameters

other WorkflowDefinition

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

Merges the given message into this one.

public void MergeFrom(WorkflowDefinition other)

Parameters

other WorkflowDefinition

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.