Table of Contents

Class ResetOptions

Namespace
Temporalio.Api.Common.V1
Assembly
Temporalio.dll

Describes where and how to reset a workflow, used for batch reset currently and may be used for single-workflow reset later.

public sealed class ResetOptions : IMessage<ResetOptions>, IEquatable<ResetOptions>, IDeepCloneable<ResetOptions>, IBufferMessage, IMessage
Inheritance
ResetOptions
Implements
IMessage<ResetOptions>
IDeepCloneable<ResetOptions>
IBufferMessage
IMessage
Inherited Members

Constructors

ResetOptions() 

public ResetOptions()

ResetOptions(ResetOptions) 

public ResetOptions(ResetOptions other)

Parameters

other ResetOptions

Fields

BuildIdFieldNumber

Field number for the "build_id" field.

public const int BuildIdFieldNumber = 4

Field Value

int

CurrentRunOnlyFieldNumber

Field number for the "current_run_only" field.

public const int CurrentRunOnlyFieldNumber = 11

Field Value

int

FirstWorkflowTaskFieldNumber

Field number for the "first_workflow_task" field.

public const int FirstWorkflowTaskFieldNumber = 1

Field Value

int

LastWorkflowTaskFieldNumber

Field number for the "last_workflow_task" field.

public const int LastWorkflowTaskFieldNumber = 2

Field Value

int

ResetReapplyTypeFieldNumber

Field number for the "reset_reapply_type" field.

public const int ResetReapplyTypeFieldNumber = 10

Field Value

int

WorkflowTaskIdFieldNumber

Field number for the "workflow_task_id" field.

public const int WorkflowTaskIdFieldNumber = 3

Field Value

int

Properties

BuildId

Resets to the first workflow task processed by this build id. If the workflow was not processed by the build id, or the workflow task can't be determined, no reset will be performed. Note that by default, this reset is allowed to be to a prior run in a chain of continue-as-new.

public string BuildId { get; set; }

Property Value

string

CurrentRunOnly

If true, limit the reset to only within the current run. (Applies to build_id targets and possibly others in the future.)

public bool CurrentRunOnly { get; set; }

Property Value

bool

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FirstWorkflowTask

Resets to the first workflow task completed or started event.

public Empty FirstWorkflowTask { get; set; }

Property Value

Empty

HasBuildId

Gets whether the "build_id" field is set

public bool HasBuildId { get; }

Property Value

bool

HasWorkflowTaskId

Gets whether the "workflow_task_id" field is set

public bool HasWorkflowTaskId { get; }

Property Value

bool

LastWorkflowTask

Resets to the last workflow task completed or started event.

public Empty LastWorkflowTask { get; set; }

Property Value

Empty

Parser 

public static MessageParser<ResetOptions> Parser { get; }

Property Value

MessageParser<ResetOptions>

ResetReapplyType

History event reapply options.

public ResetReapplyType ResetReapplyType { get; set; }

Property Value

ResetReapplyType

TargetCase 

public ResetOptions.TargetOneofCase TargetCase { get; }

Property Value

ResetOptions.TargetOneofCase

WorkflowTaskId

The id of a specific WORKFLOW_TASK_COMPLETED,WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or WORKFLOW_TASK_STARTED event to reset to. Note that this option doesn't make sense when used as part of a batch request.

public long WorkflowTaskId { get; set; }

Property Value

long

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.

ClearBuildId()

Clears the value of the oneof if it's currently set to "build_id"

public void ClearBuildId()

ClearTarget() 

public void ClearTarget()

ClearWorkflowTaskId()

Clears the value of the oneof if it's currently set to "workflow_task_id"

public void ClearWorkflowTaskId()

Clone()

Creates a deep clone of this object.

public ResetOptions Clone()

Returns

ResetOptions

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

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

public bool Equals(ResetOptions other)

Parameters

other ResetOptions

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

Merges the given message into this one.

public void MergeFrom(ResetOptions other)

Parameters

other ResetOptions

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.