Class: StructuredCalendarSpec
schedule.v1.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. Relative expressions such as "last day of the month" or "third Monday" are not currently representable; callers must enumerate the concrete days they require.
Properties
comment
• comment: string
Free-form comment describing the intention of this spec.
dayOfMonth
• dayOfMonth: $Properties[]
Match days of the month (1-31) (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: standard name of field --)
dayOfWeek
• dayOfWeek: $Properties[]
Match days of the week (0-6; 0 is Sunday).
hour
• hour: $Properties[]
Match hours (0-23)
minute
• minute: $Properties[]
Match minutes (0-59)
month
• month: $Properties[]
Match months (1-12)
second
• second: $Properties[]
Match seconds (0-59)
year
• year: $Properties[]
Match years.
Methods
toJSON
▸ toJSON(): Object
Converts this StructuredCalendarSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StructuredCalendarSpec & $Properties
Creates a new StructuredCalendarSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
StructuredCalendarSpec & $Properties
StructuredCalendarSpec instance
▸ create(properties?): StructuredCalendarSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): StructuredCalendarSpec & $Properties
Decodes a StructuredCalendarSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
StructuredCalendarSpec & $Properties
StructuredCalendarSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StructuredCalendarSpec & $Properties
Decodes a StructuredCalendarSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StructuredCalendarSpec & $Properties
StructuredCalendarSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified StructuredCalendarSpec message. Does not implicitly temporal.api.schedule.v1.StructuredCalendarSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StructuredCalendarSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StructuredCalendarSpec message, length delimited. Does not implicitly temporal.api.schedule.v1.StructuredCalendarSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StructuredCalendarSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StructuredCalendarSpec
Creates a StructuredCalendarSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StructuredCalendarSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a StructuredCalendarSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StructuredCalendarSpec | StructuredCalendarSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object