Class WorkflowExecutionCancelRequestedEventAttributes

Namespace

Temporalio.Api.History.V1

Assembly

Temporalio.dll

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

Inheritance

object

WorkflowExecutionCancelRequestedEventAttributes

Implements

IMessage<WorkflowExecutionCancelRequestedEventAttributes>

IEquatable<WorkflowExecutionCancelRequestedEventAttributes>

IDeepCloneable<WorkflowExecutionCancelRequestedEventAttributes>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkflowExecutionCancelRequestedEventAttributes()

public WorkflowExecutionCancelRequestedEventAttributes()

WorkflowExecutionCancelRequestedEventAttributes(WorkflowExecutionCancelRequestedEventAttributes)

public WorkflowExecutionCancelRequestedEventAttributes(WorkflowExecutionCancelRequestedEventAttributes other)

Parameters

other WorkflowExecutionCancelRequestedEventAttributes

Fields

CauseFieldNumber

Field number for the "cause" field.

public const int CauseFieldNumber = 1

Field Value

int

ExternalInitiatedEventIdFieldNumber

Field number for the "external_initiated_event_id" field.

public const int ExternalInitiatedEventIdFieldNumber = 2

Field Value

int

ExternalWorkflowExecutionFieldNumber

Field number for the "external_workflow_execution" field.

public const int ExternalWorkflowExecutionFieldNumber = 3

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 4

Field Value

int

Properties

Cause

User provided reason for requesting cancellation TODO: shall we create a new field with name "reason" and deprecate this one?

public string Cause { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExternalInitiatedEventId

TODO: Is this the ID of the event in the workflow which initiated this cancel, if there was one?

public long ExternalInitiatedEventId { get; set; }

Property Value

long

ExternalWorkflowExecution

public WorkflowExecution ExternalWorkflowExecution { get; set; }

Property Value

WorkflowExecution

Identity

id of the worker or client who requested this cancel

public string Identity { get; set; }

Property Value

string

Parser

public static MessageParser<WorkflowExecutionCancelRequestedEventAttributes> Parser { get; }

Property Value

MessageParser<WorkflowExecutionCancelRequestedEventAttributes>

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

Returns

WorkflowExecutionCancelRequestedEventAttributes

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

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

public bool Equals(WorkflowExecutionCancelRequestedEventAttributes other)

Parameters

other WorkflowExecutionCancelRequestedEventAttributes

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

Merges the given message into this one.

public void MergeFrom(WorkflowExecutionCancelRequestedEventAttributes other)

Parameters

other WorkflowExecutionCancelRequestedEventAttributes

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.