Class IntervalSpec
- Namespace
- Temporalio.Api.Schedule.V1
- Assembly
- Temporalio.dll
IntervalSpec matches times that can be expressed as: epoch + n * interval + phase where n is an integer. phase defaults to zero if missing. interval is required. Both interval and phase must be non-negative and are truncated to the nearest second before any calculations. For example, an interval of 1 hour with phase of zero would match every hour, on the hour. The same interval but a phase of 19 minutes would match every xx:19:00. An interval of 28 days with phase zero would match 2022-02-17T00:00:00Z (among other times). The same interval with a phase of 3 days, 5 hours, and 23 minutes would match 2022-02-20T05:23:00Z instead.
public sealed class IntervalSpec : IMessage<IntervalSpec>, IEquatable<IntervalSpec>, IDeepCloneable<IntervalSpec>, IBufferMessage, IMessage
- Inheritance
-
IntervalSpec
- Implements
-
IMessage<IntervalSpec>IDeepCloneable<IntervalSpec>IBufferMessageIMessage
- Inherited Members
Constructors
IntervalSpec()
public IntervalSpec()
IntervalSpec(IntervalSpec)
public IntervalSpec(IntervalSpec other)
Parameters
other
IntervalSpec
Fields
IntervalFieldNumber
Field number for the "interval" field.
public const int IntervalFieldNumber = 1
Field Value
PhaseFieldNumber
Field number for the "phase" field.
public const int PhaseFieldNumber = 2
Field Value
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
Interval
public Duration Interval { get; set; }
Property Value
- Duration
Parser
public static MessageParser<IntervalSpec> Parser { get; }
Property Value
- MessageParser<IntervalSpec>
Phase
public Duration Phase { get; set; }
Property Value
- Duration
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 IntervalSpec Clone()
Returns
- IntervalSpec
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(IntervalSpec)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(IntervalSpec other)
Parameters
other
IntervalSpecAn 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(IntervalSpec)
Merges the given message into this one.
public void MergeFrom(IntervalSpec other)
Parameters
other
IntervalSpec
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.