Class ScheduleState

Namespace

Temporalio.Api.Schedule.V1

Assembly

Temporalio.dll

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

Inheritance

object

ScheduleState

Implements

IMessage<ScheduleState>

IEquatable<ScheduleState>

IDeepCloneable<ScheduleState>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ScheduleState()

public ScheduleState()

ScheduleState(ScheduleState)

public ScheduleState(ScheduleState other)

Parameters

other ScheduleState

Fields

LimitedActionsFieldNumber

Field number for the "limited_actions" field.

public const int LimitedActionsFieldNumber = 3

Field Value

int

NotesFieldNumber

Field number for the "notes" field.

public const int NotesFieldNumber = 1

Field Value

int

PausedFieldNumber

Field number for the "paused" field.

public const int PausedFieldNumber = 2

Field Value

int

RemainingActionsFieldNumber

Field number for the "remaining_actions" field.

public const int RemainingActionsFieldNumber = 4

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

LimitedActions

If limited_actions is true, decrement remaining_actions after each action, and do not take any more scheduled actions if remaining_actions is zero. Actions may still be taken by explicit request (i.e. trigger immediately or backfill). Skipped actions (due to overlap policy) do not count against remaining actions. If a schedule has no more remaining actions, then the schedule will be subject to automatic deletion (after several days).

public bool LimitedActions { get; set; }

Property Value

bool

Notes

Informative human-readable message with contextual notes, e.g. the reason a schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.

public string Notes { get; set; }

Property Value

string

Parser

public static MessageParser<ScheduleState> Parser { get; }

Property Value

MessageParser<ScheduleState>

Paused

If true, do not take any actions based on the schedule spec.

public bool Paused { get; set; }

Property Value

bool

RemainingActions

public long RemainingActions { 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.

Clone()

Creates a deep clone of this object.

public ScheduleState Clone()

Returns

ScheduleState

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

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

public bool Equals(ScheduleState other)

Parameters

other ScheduleState

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

Merges the given message into this one.

public void MergeFrom(ScheduleState other)

Parameters

other ScheduleState

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.