Class SchedulePolicies

Namespace

Temporalio.Api.Schedule.V1

Assembly

Temporalio.dll

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

Inheritance

object

SchedulePolicies

Implements

IMessage<SchedulePolicies>

IEquatable<SchedulePolicies>

IDeepCloneable<SchedulePolicies>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SchedulePolicies()

public SchedulePolicies()

SchedulePolicies(SchedulePolicies)

public SchedulePolicies(SchedulePolicies other)

Parameters

other SchedulePolicies

Fields

CatchupWindowFieldNumber

Field number for the "catchup_window" field.

public const int CatchupWindowFieldNumber = 2

Field Value

int

KeepOriginalWorkflowIdFieldNumber

Field number for the "keep_original_workflow_id" field.

public const int KeepOriginalWorkflowIdFieldNumber = 4

Field Value

int

OverlapPolicyFieldNumber

Field number for the "overlap_policy" field.

public const int OverlapPolicyFieldNumber = 1

Field Value

int

PauseOnFailureFieldNumber

Field number for the "pause_on_failure" field.

public const int PauseOnFailureFieldNumber = 3

Field Value

int

Properties

CatchupWindow

Policy for catchups: If the Temporal server misses an action due to one or more components being down, and comes back up, the action will be run if the scheduled time is within this window from the current time. This value defaults to one year, and can't be less than 10 seconds.

public Duration CatchupWindow { get; set; }

Property Value

Duration

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

KeepOriginalWorkflowId

If true, and the action would start a workflow, a timestamp will not be appended to the scheduled workflow id.

public bool KeepOriginalWorkflowId { get; set; }

Property Value

bool

OverlapPolicy

Policy for overlaps. Note that this can be changed after a schedule has taken some actions, and some changes might produce unintuitive results. In general, the later policy overrides the earlier policy.

public ScheduleOverlapPolicy OverlapPolicy { get; set; }

Property Value

ScheduleOverlapPolicy

Parser

public static MessageParser<SchedulePolicies> Parser { get; }

Property Value

MessageParser<SchedulePolicies>

PauseOnFailure

If true, and a workflow run fails or times out, turn on "paused". This applies after retry policies: the full chain of retries must fail to trigger a pause here.

public bool PauseOnFailure { get; set; }

Property Value

bool

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

Returns

SchedulePolicies

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

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

public bool Equals(SchedulePolicies other)

Parameters

other SchedulePolicies

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

Merges the given message into this one.

public void MergeFrom(SchedulePolicies other)

Parameters

other SchedulePolicies

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.