Table of Contents

Class RespondWorkflowTaskCompletedRequest

Namespace
Temporalio.Api.WorkflowService.V1
Assembly
Temporalio.dll
public sealed class RespondWorkflowTaskCompletedRequest : IMessage<RespondWorkflowTaskCompletedRequest>, IEquatable<RespondWorkflowTaskCompletedRequest>, IDeepCloneable<RespondWorkflowTaskCompletedRequest>, IBufferMessage, IMessage
Inheritance
RespondWorkflowTaskCompletedRequest
Implements
Inherited Members

Constructors

RespondWorkflowTaskCompletedRequest() 

public RespondWorkflowTaskCompletedRequest()

RespondWorkflowTaskCompletedRequest(RespondWorkflowTaskCompletedRequest) 

public RespondWorkflowTaskCompletedRequest(RespondWorkflowTaskCompletedRequest other)

Parameters

other RespondWorkflowTaskCompletedRequest

Fields

BinaryChecksumFieldNumber

Field number for the "binary_checksum" field.

public const int BinaryChecksumFieldNumber = 7

Field Value

int

CommandsFieldNumber

Field number for the "commands" field.

public const int CommandsFieldNumber = 2

Field Value

int

ForceCreateNewWorkflowTaskFieldNumber

Field number for the "force_create_new_workflow_task" field.

public const int ForceCreateNewWorkflowTaskFieldNumber = 6

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 3

Field Value

int

MessagesFieldNumber

Field number for the "messages" field.

public const int MessagesFieldNumber = 11

Field Value

int

MeteringMetadataFieldNumber

Field number for the "metering_metadata" field.

public const int MeteringMetadataFieldNumber = 13

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 9

Field Value

int

QueryResultsFieldNumber

Field number for the "query_results" field.

public const int QueryResultsFieldNumber = 8

Field Value

int

ReturnNewWorkflowTaskFieldNumber

Field number for the "return_new_workflow_task" field.

public const int ReturnNewWorkflowTaskFieldNumber = 5

Field Value

int

SdkMetadataFieldNumber

Field number for the "sdk_metadata" field.

public const int SdkMetadataFieldNumber = 12

Field Value

int

StickyAttributesFieldNumber

Field number for the "sticky_attributes" field.

public const int StickyAttributesFieldNumber = 4

Field Value

int

TaskTokenFieldNumber

Field number for the "task_token" field.

public const int TaskTokenFieldNumber = 1

Field Value

int

WorkerVersionStampFieldNumber

Field number for the "worker_version_stamp" field.

public const int WorkerVersionStampFieldNumber = 10

Field Value

int

Properties

BinaryChecksum

Worker process' unique binary id

public string BinaryChecksum { get; set; }

Property Value

string

Commands

A list of commands generated when driving the workflow code in response to the new task

public RepeatedField<Command> Commands { get; }

Property Value

RepeatedField<Command>

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ForceCreateNewWorkflowTask

Can be used to force creation of a new workflow task, even if no commands have resolved or one would not otherwise have been generated. This is used when the worker knows it is doing something useful, but cannot complete it within the workflow task timeout. Local activities which run for longer than the task timeout being the prime example.

public bool ForceCreateNewWorkflowTask { get; set; }

Property Value

bool

Identity

The identity of the worker/client

public string Identity { get; set; }

Property Value

string

Messages

Protocol messages piggybacking on a WFT as a transport

public RepeatedField<Message> Messages { get; }

Property Value

RepeatedField<Message>

MeteringMetadata

Local usage data collected for metering

public MeteringMetadata MeteringMetadata { get; set; }

Property Value

MeteringMetadata

Namespace 

public string Namespace { get; set; }

Property Value

string

Parser 

public static MessageParser<RespondWorkflowTaskCompletedRequest> Parser { get; }

Property Value

MessageParser<RespondWorkflowTaskCompletedRequest>

QueryResults

Responses to the queries field in the task being responded to

public MapField<string, WorkflowQueryResult> QueryResults { get; }

Property Value

MapField<string, WorkflowQueryResult>

ReturnNewWorkflowTask

If set, the worker wishes to immediately receive the next workflow task as a response to this completion. This can save on polling round-trips.

public bool ReturnNewWorkflowTask { get; set; }

Property Value

bool

SdkMetadata

Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.

public WorkflowTaskCompletedMetadata SdkMetadata { get; set; }

Property Value

WorkflowTaskCompletedMetadata

StickyAttributes

May be set by workers to indicate that the worker desires future tasks to be provided with incremental history on a sticky queue.

public StickyExecutionAttributes StickyAttributes { get; set; }

Property Value

StickyExecutionAttributes

TaskToken

The task token as received in PollWorkflowTaskQueueResponse

public ByteString TaskToken { get; set; }

Property Value

ByteString

WorkerVersionStamp

If using versioning, the worker uses this field to indicate what version(s) it used to process the task. When this field has a worker_build_id, and binary_checksum is not set, that value should also be considered as the binary_checksum. Leaving this field empty when replying to a task has had this field previously populated in history in an error, and such a completion will be rejected.

public WorkerVersionStamp WorkerVersionStamp { get; set; }

Property Value

WorkerVersionStamp

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

Returns

RespondWorkflowTaskCompletedRequest

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

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

public bool Equals(RespondWorkflowTaskCompletedRequest other)

Parameters

other RespondWorkflowTaskCompletedRequest

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

Merges the given message into this one.

public void MergeFrom(RespondWorkflowTaskCompletedRequest other)

Parameters

other RespondWorkflowTaskCompletedRequest

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.