Class CalendarSpec
CalendarSpec describes an event specification relative to the calendar,
similar to a traditional cron specification, but with labeled fields. Each
field can be one of:
: matches always
x: matches when the field equals x
x/y : matches when the field equals x+ny where n is an integer
x-z: matches when the field is between x and z inclusive
w,x,y,...: matches when the field is one of the listed values
Each x, y, z, ... is either a decimal integer, or a month or day of week name
or abbreviation (in the appropriate fields).
A timestamp matches if all fields match.
Note that fields have different default values, for convenience.
Note that the special case that some cron implementations have for treating
day_of_month and day_of_week as "or" instead of "and" when both are set is
not implemented.
day_of_week can accept 0 or 7 as Sunday
CalendarSpec gets compiled into StructuredCalendarSpec, which is what will be
returned if you describe the schedule.
Implements
Google.Protobuf.IBufferMessage
Assembly: Temporalio.dll
Syntax
public sealed class CalendarSpec : Google.Protobuf.IMessage<CalendarSpec>, Google.Protobuf.IBufferMessage
Constructors
CalendarSpec()
Declaration
CalendarSpec(CalendarSpec)
Declaration
public CalendarSpec(CalendarSpec other)
Parameters
Fields
Field number for the "comment" field.
Declaration
public const int CommentFieldNumber = null
Field Value
DayOfMonthFieldNumber
Field number for the "day_of_month" field.
Declaration
public const int DayOfMonthFieldNumber = null
Field Value
DayOfWeekFieldNumber
Field number for the "day_of_week" field.
Declaration
public const int DayOfWeekFieldNumber = null
Field Value
HourFieldNumber
Field number for the "hour" field.
Declaration
public const int HourFieldNumber = null
Field Value
MinuteFieldNumber
Field number for the "minute" field.
Declaration
public const int MinuteFieldNumber = null
Field Value
MonthFieldNumber
Field number for the "month" field.
Declaration
public const int MonthFieldNumber = null
Field Value
SecondFieldNumber
Field number for the "second" field.
Declaration
public const int SecondFieldNumber = null
Field Value
YearFieldNumber
Field number for the "year" field.
Declaration
public const int YearFieldNumber = null
Field Value
Properties
Free-form comment describing the intention of this spec.
Declaration
public string Comment { get; set; }
Property Value
DayOfMonth
Expression to match days of the month. Default: *
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: standard name of field --)
Declaration
public string DayOfMonth { get; set; }
Property Value
DayOfWeek
Expression to match days of the week. Default: *
Declaration
public string DayOfWeek { get; set; }
Property Value
Descriptor
Declaration
public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type |
Description |
Google.Protobuf.Reflection.MessageDescriptor |
|
Hour
Expression to match hours. Default: 0
Declaration
public string Hour { get; set; }
Property Value
Minute
Expression to match minutes. Default: 0
Declaration
public string Minute { get; set; }
Property Value
Month
Expression to match months. Default: *
Declaration
public string Month { get; set; }
Property Value
Parser
Declaration
public static Google.Protobuf.MessageParser<CalendarSpec> Parser { get; }
Property Value
Type |
Description |
Google.Protobuf.MessageParser<CalendarSpec> |
|
Second
Expression to match seconds. Default: 0
Declaration
public string Second { get; set; }
Property Value
Year
Expression to match years. Default: *
Declaration
public string Year { get; set; }
Property Value
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
Clone()
Declaration
public CalendarSpec Clone()
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
Type |
Name |
Description |
Object |
other |
|
Returns
Equals(CalendarSpec)
Declaration
public bool Equals(CalendarSpec other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Declaration
public void MergeFrom(Google.Protobuf.CodedInputStream input)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedInputStream |
input |
|
MergeFrom(CalendarSpec)
Declaration
public void MergeFrom(CalendarSpec other)
Parameters
ToString()
Declaration
public override string ToString()
Returns
WriteTo(Google.Protobuf.CodedOutputStream)
Declaration
public void WriteTo(Google.Protobuf.CodedOutputStream output)
Parameters
Type |
Name |
Description |
Google.Protobuf.CodedOutputStream |
output |
|
Implements
Google.Protobuf.IBufferMessage