Class ScheduleInfo
- Namespace
- Temporalio.Api.Schedule.V1
- Assembly
- Temporalio.dll
public sealed class ScheduleInfo : IMessage<ScheduleInfo>, IEquatable<ScheduleInfo>, IDeepCloneable<ScheduleInfo>, IBufferMessage, IMessage
- Inheritance
-
ScheduleInfo
- Implements
- Inherited Members
Constructors
ScheduleInfo()
public ScheduleInfo()
ScheduleInfo(ScheduleInfo)
public ScheduleInfo(ScheduleInfo other)
Parameters
other
ScheduleInfo
Fields
ActionCountFieldNumber
Field number for the "action_count" field.
public const int ActionCountFieldNumber = 1
Field Value
CreateTimeFieldNumber
Field number for the "create_time" field.
public const int CreateTimeFieldNumber = 6
Field Value
FutureActionTimesFieldNumber
Field number for the "future_action_times" field.
public const int FutureActionTimesFieldNumber = 5
Field Value
InvalidScheduleErrorFieldNumber
Field number for the "invalid_schedule_error" field.
public const int InvalidScheduleErrorFieldNumber = 8
Field Value
MissedCatchupWindowFieldNumber
Field number for the "missed_catchup_window" field.
public const int MissedCatchupWindowFieldNumber = 2
Field Value
OverlapSkippedFieldNumber
Field number for the "overlap_skipped" field.
public const int OverlapSkippedFieldNumber = 3
Field Value
RecentActionsFieldNumber
Field number for the "recent_actions" field.
public const int RecentActionsFieldNumber = 4
Field Value
RunningWorkflowsFieldNumber
Field number for the "running_workflows" field.
public const int RunningWorkflowsFieldNumber = 9
Field Value
UpdateTimeFieldNumber
Field number for the "update_time" field.
public const int UpdateTimeFieldNumber = 7
Field Value
Properties
ActionCount
Number of actions taken so far.
public long ActionCount { get; set; }
Property Value
CreateTime
Timestamps of schedule creation and last update.
public Timestamp CreateTime { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
FutureActionTimes
Next ten scheduled action times.
public RepeatedField<Timestamp> FutureActionTimes { get; }
Property Value
InvalidScheduleError
[Obsolete]
public string InvalidScheduleError { get; set; }
Property Value
MissedCatchupWindow
Number of times a scheduled action was skipped due to missing the catchup window.
public long MissedCatchupWindow { get; set; }
Property Value
OverlapSkipped
Number of skipped actions due to overlap.
public long OverlapSkipped { get; set; }
Property Value
Parser
public static MessageParser<ScheduleInfo> Parser { get; }
Property Value
RecentActions
Most recent ten actual action times (including manual triggers).
public RepeatedField<ScheduleActionResult> RecentActions { get; }
Property Value
RunningWorkflows
Currently-running workflows started by this schedule. (There might be more than one if the overlap policy allows overlaps.) Note that the run_ids in here are the original execution run ids as started by the schedule. If the workflows retried, did continue-as-new, or were reset, they might still be running but with a different run_id.
public RepeatedField<WorkflowExecution> RunningWorkflows { get; }
Property Value
UpdateTime
public Timestamp UpdateTime { get; set; }
Property Value
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 ScheduleInfo Clone()
Returns
- ScheduleInfo
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
Equals(ScheduleInfo)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(ScheduleInfo other)
Parameters
other
ScheduleInfoAn object to compare with this object.
Returns
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(ScheduleInfo)
Merges the given message into this one.
public void MergeFrom(ScheduleInfo other)
Parameters
other
ScheduleInfo
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
CodedOutputStreamCoded output stream to write the data to. Must not be null.