Class TimeSkippingInfo

Namespace

Temporalio.Api.Common.V1

Assembly

Temporalio.dll

Describes the current time-skipping state of a workflow execution.

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

Inheritance

object

TimeSkippingInfo

Implements

IMessage<TimeSkippingInfo>

IEquatable<TimeSkippingInfo>

IDeepCloneable<TimeSkippingInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TimeSkippingInfo()

public TimeSkippingInfo()

TimeSkippingInfo(TimeSkippingInfo)

public TimeSkippingInfo(TimeSkippingInfo other)

Parameters

other TimeSkippingInfo

Fields

CurrentSessionSkipCountFieldNumber

Field number for the "current_session_skip_count" field.

public const int CurrentSessionSkipCountFieldNumber = 6

Field Value

int

CurrentTimeFieldNumber

Field number for the "current_time" field.

public const int CurrentTimeFieldNumber = 1

Field Value

int

EffectiveConfigFieldNumber

Field number for the "effective_config" field.

public const int EffectiveConfigFieldNumber = 2

Field Value

int

FastForwardInfoFieldNumber

Field number for the "fast_forward_info" field.

public const int FastForwardInfoFieldNumber = 4

Field Value

int

Properties

CurrentSessionSkipCount

The number of skips accumulated in the current session, bounded by max_session_skip_count. A new session begins — and this resets to 0 — each time max_session_skip_count is updated.

public int CurrentSessionSkipCount { get; set; }

Property Value

int

CurrentTime

Current virtual time of the execution. If the execution hasn't skipped any time yet, it will be the same as wall clock time.

public Timestamp CurrentTime { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EffectiveConfig

The current effective time-skipping config, which can differ from the config the user last set: internally-defaulted fields are populated, and enabled reflects whether the execution is still skipping time — e.g. it is set to false once max_session_skip_count is reached, the fast-forward completes, or a client call disables time skipping.

public TimeSkippingConfig EffectiveConfig { get; set; }

Property Value

TimeSkippingConfig

FastForwardInfo

The execution's current fast-forward, if any. Unset if time skipping is enabled without a fast-forward.

public TimeSkippingFastForwardInfo FastForwardInfo { get; set; }

Property Value

TimeSkippingFastForwardInfo

Parser

public static MessageParser<TimeSkippingInfo> Parser { get; }

Property Value

MessageParser<TimeSkippingInfo>

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

Returns

TimeSkippingInfo

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

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

public bool Equals(TimeSkippingInfo other)

Parameters

other TimeSkippingInfo

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

Merges the given message into this one.

public void MergeFrom(TimeSkippingInfo other)

Parameters

other TimeSkippingInfo

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.