Table of Contents

Class FastForwardConfig

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

Constructors

FastForwardConfig() 

public FastForwardConfig()

FastForwardConfig(FastForwardConfig) 

public FastForwardConfig(FastForwardConfig other)

Parameters

other FastForwardConfig

Fields

DurationFieldNumber

Field number for the "duration" field.

public const int DurationFieldNumber = 2

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Duration

Fast-forward the current execution by this duration ahead of the current execution time; required field. The duration yields a target time (current execution time + duration), surfaced as target_time in TimeSkippingFastForwardInfo. Once virtual time reaches that target, the fast-forward completes, time skipping is disabled, and no further time is skipped. Time skipping can be resumed either by updating the TimeSkippingConfig with a new FastForwardConfig, or by clearing the FastForwardConfig to skip through to the end of the execution.

If this duration exceeds the remaining execution timeout, time will not pass beyond the end of the execution, and the fast-forward won't have a chance to complete.

public Duration Duration { get; set; }

Property Value

Duration

Id

A client-supplied ID, required field, set alongside duration. It is used to poll for fast-forward completion via PollWorkflowExecutionTimeSkipping. The server performs no idempotency check on this ID; the client is responsible for managing it.

public string Id { get; set; }

Property Value

string

Parser 

public static MessageParser<FastForwardConfig> Parser { get; }

Property Value

MessageParser<FastForwardConfig>

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

Returns

FastForwardConfig

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

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

public bool Equals(FastForwardConfig other)

Parameters

other FastForwardConfig

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

Merges the given message into this one.

public void MergeFrom(FastForwardConfig other)

Parameters

other FastForwardConfig

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.