Class SignalWorkflowExecutionRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

SignalWorkflowExecutionRequest

Implements

IMessage<SignalWorkflowExecutionRequest>

IEquatable<SignalWorkflowExecutionRequest>

IDeepCloneable<SignalWorkflowExecutionRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SignalWorkflowExecutionRequest()

public SignalWorkflowExecutionRequest()

SignalWorkflowExecutionRequest(SignalWorkflowExecutionRequest)

public SignalWorkflowExecutionRequest(SignalWorkflowExecutionRequest other)

Parameters

other SignalWorkflowExecutionRequest

Fields

ControlFieldNumber

Field number for the "control" field.

public const int ControlFieldNumber = 7

Field Value

int

HeaderFieldNumber

Field number for the "header" field.

public const int HeaderFieldNumber = 8

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 5

Field Value

int

InputFieldNumber

Field number for the "input" field.

public const int InputFieldNumber = 4

Field Value

int

LinksFieldNumber

Field number for the "links" field.

public const int LinksFieldNumber = 10

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 6

Field Value

int

SignalNameFieldNumber

Field number for the "signal_name" field.

public const int SignalNameFieldNumber = 3

Field Value

int

SkipGenerateWorkflowTaskFieldNumber

Field number for the "skip_generate_workflow_task" field.

public const int SkipGenerateWorkflowTaskFieldNumber = 9

Field Value

int

WorkflowExecutionFieldNumber

Field number for the "workflow_execution" field.

public const int WorkflowExecutionFieldNumber = 2

Field Value

int

Properties

Control

Deprecated

public string Control { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Header

Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.

public Header Header { get; set; }

Property Value

Header

Identity

The identity of the worker/client

public string Identity { get; set; }

Property Value

string

Input

Serialized value(s) to provide with the signal

public Payloads Input { get; set; }

Property Value

Payloads

Links

Links to be associated with the WorkflowExecutionSignaled event.

public RepeatedField<Link> Links { get; }

Property Value

RepeatedField<Link>

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<SignalWorkflowExecutionRequest> Parser { get; }

Property Value

MessageParser<SignalWorkflowExecutionRequest>

RequestId

Used to de-dupe sent signals

public string RequestId { get; set; }

Property Value

string

SignalName

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

public string SignalName { get; set; }

Property Value

string

SkipGenerateWorkflowTask

Indicates that a new workflow task should not be generated when this signal is received.

public bool SkipGenerateWorkflowTask { get; set; }

Property Value

bool

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

Returns

SignalWorkflowExecutionRequest

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

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

public bool Equals(SignalWorkflowExecutionRequest other)

Parameters

other SignalWorkflowExecutionRequest

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

Merges the given message into this one.

public void MergeFrom(SignalWorkflowExecutionRequest other)

Parameters

other SignalWorkflowExecutionRequest

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.