Class StructuredCalendarSpec

Namespace

Temporalio.Api.Schedule.V1

Assembly

Temporalio.dll

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

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

Inheritance

object

StructuredCalendarSpec

Implements

IMessage<StructuredCalendarSpec>

IEquatable<StructuredCalendarSpec>

IDeepCloneable<StructuredCalendarSpec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StructuredCalendarSpec()

public StructuredCalendarSpec()

StructuredCalendarSpec(StructuredCalendarSpec)

public StructuredCalendarSpec(StructuredCalendarSpec other)

Parameters

other StructuredCalendarSpec

Fields

CommentFieldNumber

Field number for the "comment" field.

public const int CommentFieldNumber = 8

Field Value

int

DayOfMonthFieldNumber

Field number for the "day_of_month" field.

public const int DayOfMonthFieldNumber = 4

Field Value

int

DayOfWeekFieldNumber

Field number for the "day_of_week" field.

public const int DayOfWeekFieldNumber = 7

Field Value

int

HourFieldNumber

Field number for the "hour" field.

public const int HourFieldNumber = 3

Field Value

int

MinuteFieldNumber

Field number for the "minute" field.

public const int MinuteFieldNumber = 2

Field Value

int

MonthFieldNumber

Field number for the "month" field.

public const int MonthFieldNumber = 5

Field Value

int

SecondFieldNumber

Field number for the "second" field.

public const int SecondFieldNumber = 1

Field Value

int

YearFieldNumber

Field number for the "year" field.

public const int YearFieldNumber = 6

Field Value

int

Properties

Comment

Free-form comment describing the intention of this spec.

public string Comment { get; set; }

Property Value

string

DayOfMonth

Match days of the month (1-31) (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: standard name of field --)

public RepeatedField<Range> DayOfMonth { get; }

Property Value

RepeatedField<Range>

DayOfWeek

Match days of the week (0-6; 0 is Sunday).

public RepeatedField<Range> DayOfWeek { get; }

Property Value

RepeatedField<Range>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Hour

Match hours (0-23)

public RepeatedField<Range> Hour { get; }

Property Value

RepeatedField<Range>

Minute

Match minutes (0-59)

public RepeatedField<Range> Minute { get; }

Property Value

RepeatedField<Range>

Month

Match months (1-12)

public RepeatedField<Range> Month { get; }

Property Value

RepeatedField<Range>

Parser

public static MessageParser<StructuredCalendarSpec> Parser { get; }

Property Value

MessageParser<StructuredCalendarSpec>

Second

Match seconds (0-59)

public RepeatedField<Range> Second { get; }

Property Value

RepeatedField<Range>

Year

Match years.

public RepeatedField<Range> Year { get; }

Property Value

RepeatedField<Range>

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 StructuredCalendarSpec Clone()

Returns

StructuredCalendarSpec

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

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

public bool Equals(StructuredCalendarSpec other)

Parameters

other StructuredCalendarSpec

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

Merges the given message into this one.

public void MergeFrom(StructuredCalendarSpec other)

Parameters

other StructuredCalendarSpec

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.