Class SignalExternalWorkflowExecutionCommandAttributes

Namespace

Temporalio.Api.Command.V1

Assembly

Temporalio.dll

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

Inheritance

object

SignalExternalWorkflowExecutionCommandAttributes

Implements

IMessage<SignalExternalWorkflowExecutionCommandAttributes>

IEquatable<SignalExternalWorkflowExecutionCommandAttributes>

IDeepCloneable<SignalExternalWorkflowExecutionCommandAttributes>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SignalExternalWorkflowExecutionCommandAttributes()

public SignalExternalWorkflowExecutionCommandAttributes()

SignalExternalWorkflowExecutionCommandAttributes(SignalExternalWorkflowExecutionCommandAttributes)

public SignalExternalWorkflowExecutionCommandAttributes(SignalExternalWorkflowExecutionCommandAttributes other)

Parameters

other SignalExternalWorkflowExecutionCommandAttributes

Fields

ChildWorkflowOnlyFieldNumber

Field number for the "child_workflow_only" field.

public const int ChildWorkflowOnlyFieldNumber = 6

Field Value

int

ControlFieldNumber

Field number for the "control" field.

public const int ControlFieldNumber = 5

Field Value

int

ExecutionFieldNumber

Field number for the "execution" field.

public const int ExecutionFieldNumber = 2

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 7

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 4

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

SignalNameFieldNumber

Field number for the "signal_name" field.

public const int SignalNameFieldNumber = 3

Field Value

int

Properties

ChildWorkflowOnly

Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.

public bool ChildWorkflowOnly { get; set; }

Property Value

bool

Control

Deprecated

[Obsolete]
public string Control { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Execution

public WorkflowExecution Execution { get; set; }

Property Value

WorkflowExecution

Header

Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.

public Header Header { get; set; }

Property Value

Header

Input

Serialized value(s) to provide with the signal.

public Payloads Input { get; set; }

Property Value

Payloads

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<SignalExternalWorkflowExecutionCommandAttributes> Parser { get; }

Property Value

MessageParser<SignalExternalWorkflowExecutionCommandAttributes>

SignalName

The workflow author-defined name of the signal to send to the workflow.

public string SignalName { get; set; }

Property Value

string

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

Returns

SignalExternalWorkflowExecutionCommandAttributes

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

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

public bool Equals(SignalExternalWorkflowExecutionCommandAttributes other)

Parameters

other SignalExternalWorkflowExecutionCommandAttributes

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

Merges the given message into this one.

public void MergeFrom(SignalExternalWorkflowExecutionCommandAttributes other)

Parameters

other SignalExternalWorkflowExecutionCommandAttributes

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.