Class WorkflowInteractionDefinition

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

(-- api-linter: core::0123::resource-annotation=disabled aip.dev/not-precedent: The name field is optional. --) (-- api-linter: core::0203::optional=disabled --)

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

Inheritance

object

WorkflowInteractionDefinition

Implements

IMessage<WorkflowInteractionDefinition>

IEquatable<WorkflowInteractionDefinition>

IDeepCloneable<WorkflowInteractionDefinition>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowInteractionDefinition()

public WorkflowInteractionDefinition()

WorkflowInteractionDefinition(WorkflowInteractionDefinition)

public WorkflowInteractionDefinition(WorkflowInteractionDefinition other)

Parameters

other WorkflowInteractionDefinition

Fields

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 2

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

Properties

Description

An optional interaction 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

Name

An optional name for the handler. If missing, it represents a dynamic handler that processes any interactions not handled by others. There is at most one dynamic handler per workflow and interaction kind.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowInteractionDefinition> Parser { get; }

Property Value

MessageParser<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 WorkflowInteractionDefinition Clone()

Returns

WorkflowInteractionDefinition

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

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

public bool Equals(WorkflowInteractionDefinition other)

Parameters

other WorkflowInteractionDefinition

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

Merges the given message into this one.

public void MergeFrom(WorkflowInteractionDefinition other)

Parameters

other WorkflowInteractionDefinition

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.