Module: schedule

Copyright 2020 Parsable, Inc

This namespace is for data structures and definitions that are re-used between services, and does not contain any service definitions.

Module	Services	Data types	Constants
schedule	ScheduleService	GetScheduleResult RecurringRule RepeatFrequency Schedule ScheduleLog

Enumerations

Enumeration: RepeatFrequency

`MINUTELY`	`0`
`HOURLY`	`1`
`DAILY`	`2`
`WEEKLY`	`3`
`MONTHLY`	`4`
`YEARLY`	`5`

Data structures

Struct: RecurringRule

Key	Field	Type	Description	Requiredness	Default value
1	startTime	`string`	The start and end time formats should be "YYYY-MM-DDTHH:MM:SS -0800"	default
2	endTime	`string`	if unset assumes will repeat forever	optional
3	repeatTimes	`i32`	If unset or negative will repeat forever	optional
4	repeat	`RepeatFrequency`	0 - Minutely, 1 - Hourly, 2 - Daily, 3 - Weekly, 4 - Monthly, 5 - Yearly. Minutely, Hourly and Yearly not supported right now	default
5	repeatInterval	`i32`		default	`1`
6	dayOfWeek	`list<i32>`	0 - Sunday to 6 - Saturday	optional
7	dayOfMonth	`list<i32>`	from 1 to 31	optional
8	month	`list<i32>`	from 1 to 12	optional
20	location	`string`		optional

Struct: ScheduleLog

Key	Field	Type	Description	Requiredness	Default value
1	scheduleId	`string`		default
2	runAt	`string`		default
3	error	`string`		default
4	nextRunAt	`string`		default
5	timeStartedAt	`i64`		default
6	timeTaken	`i64`	This is in NANO-seconds	default

Struct: Schedule

Key	Field	Type	Description	Requiredness	Default value
1	id	`string`		default
2	ownerId	`string`		default
3	scheduleType	`i32`		default
4	numRuns	`i32`		default
5	numFailures	`i32`		default
6	lastSuccess	`string`		default
7	nextRunAt	`string`		default
9	rule	`RecurringRule`		optional
10	completedAt	`string`		default
11	pausedAt	`string`		default
12	error	`string`		optional

Struct: GetScheduleResult

Key	Field	Type	Description	Requiredness	Default value
1	schedule	`Schedule`		default
2	logs	`list<ScheduleLog>`		optional
3	nextScheduledRuns	`list<string>`		optional

Services

Service: ScheduleService