Table of Contents

Class Command

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

Constructors

Command() 

public Command()

Command(Command) 

public Command(Command other)

Parameters

other Command

Fields

CancelTimerCommandAttributesFieldNumber

Field number for the "cancel_timer_command_attributes" field.

public const int CancelTimerCommandAttributesFieldNumber = 7

Field Value

int

CancelWorkflowExecutionCommandAttributesFieldNumber

Field number for the "cancel_workflow_execution_command_attributes" field.

public const int CancelWorkflowExecutionCommandAttributesFieldNumber = 8

Field Value

int

CommandTypeFieldNumber

Field number for the "command_type" field.

public const int CommandTypeFieldNumber = 1

Field Value

int

CompleteWorkflowExecutionCommandAttributesFieldNumber

Field number for the "complete_workflow_execution_command_attributes" field.

public const int CompleteWorkflowExecutionCommandAttributesFieldNumber = 4

Field Value

int

ContinueAsNewWorkflowExecutionCommandAttributesFieldNumber

Field number for the "continue_as_new_workflow_execution_command_attributes" field.

public const int ContinueAsNewWorkflowExecutionCommandAttributesFieldNumber = 11

Field Value

int

FailWorkflowExecutionCommandAttributesFieldNumber

Field number for the "fail_workflow_execution_command_attributes" field.

public const int FailWorkflowExecutionCommandAttributesFieldNumber = 5

Field Value

int

ModifyWorkflowPropertiesCommandAttributesFieldNumber

Field number for the "modify_workflow_properties_command_attributes" field.

public const int ModifyWorkflowPropertiesCommandAttributesFieldNumber = 17

Field Value

int

ProtocolMessageCommandAttributesFieldNumber

Field number for the "protocol_message_command_attributes" field.

public const int ProtocolMessageCommandAttributesFieldNumber = 15

Field Value

int

RecordMarkerCommandAttributesFieldNumber

Field number for the "record_marker_command_attributes" field.

public const int RecordMarkerCommandAttributesFieldNumber = 10

Field Value

int

RequestCancelActivityTaskCommandAttributesFieldNumber

Field number for the "request_cancel_activity_task_command_attributes" field.

public const int RequestCancelActivityTaskCommandAttributesFieldNumber = 6

Field Value

int

RequestCancelExternalWorkflowExecutionCommandAttributesFieldNumber

Field number for the "request_cancel_external_workflow_execution_command_attributes" field.

public const int RequestCancelExternalWorkflowExecutionCommandAttributesFieldNumber = 9

Field Value

int

RequestCancelNexusOperationCommandAttributesFieldNumber

Field number for the "request_cancel_nexus_operation_command_attributes" field.

public const int RequestCancelNexusOperationCommandAttributesFieldNumber = 19

Field Value

int

ScheduleActivityTaskCommandAttributesFieldNumber

Field number for the "schedule_activity_task_command_attributes" field.

public const int ScheduleActivityTaskCommandAttributesFieldNumber = 2

Field Value

int

ScheduleNexusOperationCommandAttributesFieldNumber

Field number for the "schedule_nexus_operation_command_attributes" field.

public const int ScheduleNexusOperationCommandAttributesFieldNumber = 18

Field Value

int

SignalExternalWorkflowExecutionCommandAttributesFieldNumber

Field number for the "signal_external_workflow_execution_command_attributes" field.

public const int SignalExternalWorkflowExecutionCommandAttributesFieldNumber = 13

Field Value

int

StartChildWorkflowExecutionCommandAttributesFieldNumber

Field number for the "start_child_workflow_execution_command_attributes" field.

public const int StartChildWorkflowExecutionCommandAttributesFieldNumber = 12

Field Value

int

StartTimerCommandAttributesFieldNumber

Field number for the "start_timer_command_attributes" field.

public const int StartTimerCommandAttributesFieldNumber = 3

Field Value

int

UpsertWorkflowSearchAttributesCommandAttributesFieldNumber

Field number for the "upsert_workflow_search_attributes_command_attributes" field.

public const int UpsertWorkflowSearchAttributesCommandAttributesFieldNumber = 14

Field Value

int

UserMetadataFieldNumber

Field number for the "user_metadata" field.

public const int UserMetadataFieldNumber = 301

Field Value

int

Properties

AttributesCase 

public Command.AttributesOneofCase AttributesCase { get; }

Property Value

Command.AttributesOneofCase

CancelTimerCommandAttributes 

public CancelTimerCommandAttributes CancelTimerCommandAttributes { get; set; }

Property Value

CancelTimerCommandAttributes

CancelWorkflowExecutionCommandAttributes 

public CancelWorkflowExecutionCommandAttributes CancelWorkflowExecutionCommandAttributes { get; set; }

Property Value

CancelWorkflowExecutionCommandAttributes

CommandType 

public CommandType CommandType { get; set; }

Property Value

CommandType

CompleteWorkflowExecutionCommandAttributes 

public CompleteWorkflowExecutionCommandAttributes CompleteWorkflowExecutionCommandAttributes { get; set; }

Property Value

CompleteWorkflowExecutionCommandAttributes

ContinueAsNewWorkflowExecutionCommandAttributes 

public ContinueAsNewWorkflowExecutionCommandAttributes ContinueAsNewWorkflowExecutionCommandAttributes { get; set; }

Property Value

ContinueAsNewWorkflowExecutionCommandAttributes

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FailWorkflowExecutionCommandAttributes 

public FailWorkflowExecutionCommandAttributes FailWorkflowExecutionCommandAttributes { get; set; }

Property Value

FailWorkflowExecutionCommandAttributes

ModifyWorkflowPropertiesCommandAttributes

16 is available for use - it was used as part of a prototype that never made it into a release

public ModifyWorkflowPropertiesCommandAttributes ModifyWorkflowPropertiesCommandAttributes { get; set; }

Property Value

ModifyWorkflowPropertiesCommandAttributes

Parser 

public static MessageParser<Command> Parser { get; }

Property Value

MessageParser<Command>

ProtocolMessageCommandAttributes 

public ProtocolMessageCommandAttributes ProtocolMessageCommandAttributes { get; set; }

Property Value

ProtocolMessageCommandAttributes

RecordMarkerCommandAttributes 

public RecordMarkerCommandAttributes RecordMarkerCommandAttributes { get; set; }

Property Value

RecordMarkerCommandAttributes

RequestCancelActivityTaskCommandAttributes 

public RequestCancelActivityTaskCommandAttributes RequestCancelActivityTaskCommandAttributes { get; set; }

Property Value

RequestCancelActivityTaskCommandAttributes

RequestCancelExternalWorkflowExecutionCommandAttributes 

public RequestCancelExternalWorkflowExecutionCommandAttributes RequestCancelExternalWorkflowExecutionCommandAttributes { get; set; }

Property Value

RequestCancelExternalWorkflowExecutionCommandAttributes

RequestCancelNexusOperationCommandAttributes 

public RequestCancelNexusOperationCommandAttributes RequestCancelNexusOperationCommandAttributes { get; set; }

Property Value

RequestCancelNexusOperationCommandAttributes

ScheduleActivityTaskCommandAttributes 

public ScheduleActivityTaskCommandAttributes ScheduleActivityTaskCommandAttributes { get; set; }

Property Value

ScheduleActivityTaskCommandAttributes

ScheduleNexusOperationCommandAttributes 

public ScheduleNexusOperationCommandAttributes ScheduleNexusOperationCommandAttributes { get; set; }

Property Value

ScheduleNexusOperationCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes 

public SignalExternalWorkflowExecutionCommandAttributes SignalExternalWorkflowExecutionCommandAttributes { get; set; }

Property Value

SignalExternalWorkflowExecutionCommandAttributes

StartChildWorkflowExecutionCommandAttributes 

public StartChildWorkflowExecutionCommandAttributes StartChildWorkflowExecutionCommandAttributes { get; set; }

Property Value

StartChildWorkflowExecutionCommandAttributes

StartTimerCommandAttributes 

public StartTimerCommandAttributes StartTimerCommandAttributes { get; set; }

Property Value

StartTimerCommandAttributes

UpsertWorkflowSearchAttributesCommandAttributes 

public UpsertWorkflowSearchAttributesCommandAttributes UpsertWorkflowSearchAttributesCommandAttributes { get; set; }

Property Value

UpsertWorkflowSearchAttributesCommandAttributes

UserMetadata

Metadata on the command. This is sometimes carried over to the history event if one is created as a result of the command. Most commands won't have this information, and how this information is used is dependent upon the interface that reads it.

Current well-known uses:

  • start_child_workflow_execution_command_attributes - populates temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details are used by user interfaces to show fixed as-of-start workflow summary and details.
  • start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer started where the summary is used to identify the timer.
public UserMetadata UserMetadata { get; set; }

Property Value

UserMetadata

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.

ClearAttributes() 

public void ClearAttributes()

Clone()

Creates a deep clone of this object.

public Command Clone()

Returns

Command

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

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

public bool Equals(Command other)

Parameters

other Command

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

Merges the given message into this one.

public void MergeFrom(Command other)

Parameters

other Command

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.