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

Object

StructuredCalendarSpec

Implements

Google.Protobuf.IBufferMessage

Namespace: Temporalio.Api.Schedule.V1

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

Type	Name	Description
StructuredCalendarSpec	other

Fields

CommentFieldNumber

Field number for the "comment" field.

Declaration

public const int CommentFieldNumber = null

Field Value

Type	Description
Int32

DayOfMonthFieldNumber

Field number for the "day_of_month" field.

Declaration

public const int DayOfMonthFieldNumber = null

Field Value

Type	Description
Int32

DayOfWeekFieldNumber

Field number for the "day_of_week" field.

Declaration

public const int DayOfWeekFieldNumber = null

Field Value

Type	Description
Int32

HourFieldNumber

Field number for the "hour" field.

Declaration

public const int HourFieldNumber = null

Field Value

Type	Description
Int32

MinuteFieldNumber

Field number for the "minute" field.

Declaration

public const int MinuteFieldNumber = null

Field Value

Type	Description
Int32

MonthFieldNumber

Field number for the "month" field.

Declaration

public const int MonthFieldNumber = null

Field Value

Type	Description
Int32

SecondFieldNumber

Field number for the "second" field.

Declaration

public const int SecondFieldNumber = null

Field Value

Type	Description
Int32

YearFieldNumber

Field number for the "year" field.

Declaration

public const int YearFieldNumber = null

Field Value

Type	Description
Int32

Properties

Comment

Free-form comment describing the intention of this spec.

Declaration

public string Comment { get; set; }

Property Value

Type	Description
String

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

Match hours (0-23)

Declaration

public Google.Protobuf.Collections.RepeatedField<Range> Hour { get; }

Property Value

Type	Description
Google.Protobuf.Collections.RepeatedField<Range>

Minute

Match minutes (0-59)

Declaration

public Google.Protobuf.Collections.RepeatedField<Range> Minute { get; }

Property Value

Type	Description
Google.Protobuf.Collections.RepeatedField<Range>

Month

Match months (1-12)

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

Type	Description
Google.Protobuf.MessageParser<StructuredCalendarSpec>

Second

Match seconds (0-59)

Declaration

public Google.Protobuf.Collections.RepeatedField<Range> Second { get; }

Property Value

Type	Description
Google.Protobuf.Collections.RepeatedField<Range>

Year

Match years.

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

Type	Description
Int32

Clone()

Declaration

public StructuredCalendarSpec Clone()

Returns

Type	Description
StructuredCalendarSpec

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
Object	other

Returns

Type	Description
Boolean

Equals(StructuredCalendarSpec)

Declaration

public bool Equals(StructuredCalendarSpec other)

Parameters

Type	Name	Description
StructuredCalendarSpec	other

Returns

Type	Description
Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

MergeFrom(Google.Protobuf.CodedInputStream)

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

Type	Name	Description
StructuredCalendarSpec	other

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

WriteTo(Google.Protobuf.CodedOutputStream)

Declaration

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

Type	Name	Description
Google.Protobuf.CodedOutputStream	output

Implements

Google.Protobuf.IBufferMessage