Class StructuredCalendarSpec
StructuredCalendarSpec describes an event specification relative to the
calendar, in a form that's easy to work with programmatically. Each field can
be one or more ranges.
A timestamp matches if at least one range of each field matches the
corresponding fields of the timestamp, except for year: if year is missing,
that means all years match. For all fields besides year, at least one Range
must be present to match anything.
TODO: add relative-to-end-of-month
TODO: add nth day-of-week in month
Inheritance
StructuredCalendarSpec
Implements
Google.Protobuf.IBufferMessage
Assembly: Temporalio.dll
Syntax
public sealed class StructuredCalendarSpec : Google.Protobuf.IMessage<StructuredCalendarSpec>, Google.Protobuf.IBufferMessage
Constructors
StructuredCalendarSpec()
Declaration
public StructuredCalendarSpec()
StructuredCalendarSpec(StructuredCalendarSpec)
Declaration
public StructuredCalendarSpec(StructuredCalendarSpec 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
Match days of the month (1-31)
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: standard name of field --)
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> DayOfMonth { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
DayOfWeek
Match days of the week (0-6; 0 is Sunday).
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> DayOfWeek { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Descriptor
Declaration
public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type |
Description |
Google.Protobuf.Reflection.MessageDescriptor |
|
Hour
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> Hour { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Minute
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> Minute { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Month
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> Month { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Parser
Declaration
public static Google.Protobuf.MessageParser<StructuredCalendarSpec> Parser { get; }
Property Value
Second
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> Second { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Year
Declaration
public Google.Protobuf.Collections.RepeatedField<Range> Year { get; }
Property Value
Type |
Description |
Google.Protobuf.Collections.RepeatedField<Range> |
|
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
Clone()
Declaration
public StructuredCalendarSpec Clone()
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
Type |
Name |
Description |
Object |
other |
|
Returns
Equals(StructuredCalendarSpec)
Declaration
public bool Equals(StructuredCalendarSpec 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(StructuredCalendarSpec)
Declaration
public void MergeFrom(StructuredCalendarSpec 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