Class RequestCancelWorkflowExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

RequestCancelWorkflowExecutionRequest

Implements

IMessage<RequestCancelWorkflowExecutionRequest>

IEquatable<RequestCancelWorkflowExecutionRequest>

IDeepCloneable<RequestCancelWorkflowExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RequestCancelWorkflowExecutionRequest()

public RequestCancelWorkflowExecutionRequest()

RequestCancelWorkflowExecutionRequest(RequestCancelWorkflowExecutionRequest)

public RequestCancelWorkflowExecutionRequest(RequestCancelWorkflowExecutionRequest other)

Parameters

other RequestCancelWorkflowExecutionRequest

Fields

FirstExecutionRunIdFieldNumber

Field number for the "first_execution_run_id" field.

public const int FirstExecutionRunIdFieldNumber = 5

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 3

Field Value

int

LinksFieldNumber

Field number for the "links" field.

public const int LinksFieldNumber = 7

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 6

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 4

Field Value

int

WorkflowExecutionFieldNumber

Field number for the "workflow_execution" field.

public const int WorkflowExecutionFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FirstExecutionRunId

If set, this call will error if the most recent (if no run id is set on workflow_execution), or specified (if it is) workflow execution is not part of the same execution chain as this id.

public string FirstExecutionRunId { get; set; }

Property Value

string

Identity

The identity of the worker/client

public string Identity { get; set; }

Property Value

string

Links

Links to be associated with the WorkflowExecutionCanceled event.

public RepeatedField<Link> Links { get; }

Property Value

RepeatedField<Link>

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<RequestCancelWorkflowExecutionRequest> Parser { get; }

Property Value

MessageParser<RequestCancelWorkflowExecutionRequest>

Reason

Reason for requesting the cancellation

public string Reason { get; set; }

Property Value

string

RequestId

Used to de-dupe cancellation requests

public string RequestId { get; set; }

Property Value

string

WorkflowExecution

public WorkflowExecution WorkflowExecution { get; set; }

Property Value

WorkflowExecution

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

Returns

RequestCancelWorkflowExecutionRequest

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

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

public bool Equals(RequestCancelWorkflowExecutionRequest other)

Parameters

other RequestCancelWorkflowExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(RequestCancelWorkflowExecutionRequest other)

Parameters

other RequestCancelWorkflowExecutionRequest

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.