ItemSchedule interface
An interface representing the schedule info of item
Properties
| cron |
The period in minutes for cron schedule type |
| cron |
The unit for TWT cron schedule type |
| execution |
The optional payload in json format string that will be passed when starting job |
| item |
The configured job type |
| item |
The object id of the item |
| job |
The object id of the item job definition |
| last |
The utc timestamp of last update |
| local |
The timezone of the schedule start/end time |
| max |
The optional max concurrency of the schedule; default value is 1 |
| max |
The optional maximum number of retries for the schedule; default value is 1 |
| next |
The timestamp of the next scheduled job to run, calculated based on the time and schedule type |
| next |
The utc timestamp of the next scheduled job to run, calculated based on the time and schedule type |
| owner |
The owner user(last modifier) of the schedule |
| parameters | The optional job parameters setting |
| schedule |
Whether it is enabled |
| schedule |
The time to stop the schedule |
| schedule |
The list of time to schedule job for daily/weekly schedule type |
| schedule |
The day(s) that are specified for monthly schedule |
| schedule |
The schedule period that is specified for monthly scheduling |
| schedule |
The time to start the schedule |
| schedule |
The type of schedule |
| schedule |
The weekdays that are selected for scheduling for daily/weekly/monthly schedule type |
| schedule |
The week that is specified for monthly schedule with relative monthly option |
Property Details
cronPeriod
The period in minutes for cron schedule type
cronPeriod?: numberProperty Value
number
cronUnit
The unit for TWT cron schedule type
cronUnit?: CronUnitProperty Value
CronUnit
executionData
The optional payload in json format string that will be passed when starting job
executionData?: stringProperty Value
string
itemJobType
The configured job type
itemJobType: stringProperty Value
string
itemObjectId
The object id of the item
itemObjectId: stringProperty Value
string
jobDefinitionObjectId
The object id of the item job definition
jobDefinitionObjectId: stringProperty Value
string
lastUpdateTimeUtc
The utc timestamp of last update
lastUpdateTimeUtc?: stringProperty Value
string
localTimeZoneId
The timezone of the schedule start/end time
localTimeZoneId: stringProperty Value
string
maxConcurrency
The optional max concurrency of the schedule; default value is 1
maxConcurrency?: numberProperty Value
number
maxNumRetries
The optional maximum number of retries for the schedule; default value is 1
maxNumRetries?: numberProperty Value
number
nextJobScheduleTime
The timestamp of the next scheduled job to run, calculated based on the time and schedule type
nextJobScheduleTime?: stringProperty Value
string
nextJobScheduleTimeUtc
The utc timestamp of the next scheduled job to run, calculated based on the time and schedule type
nextJobScheduleTimeUtc?: stringProperty Value
string
ownerUser
parameters
The optional job parameters setting
parameters?: ParameterItem[]Property Value
ParameterItem[]
scheduleEnabled
Whether it is enabled
scheduleEnabled: booleanProperty Value
boolean
scheduleEndTime
The time to stop the schedule
scheduleEndTime?: stringProperty Value
string
scheduleHours
The list of time to schedule job for daily/weekly schedule type
scheduleHours?: string[]Property Value
string[]
scheduleMonthDays
The day(s) that are specified for monthly schedule
scheduleMonthDays?: number[]Property Value
number[]
schedulePeriod
The schedule period that is specified for monthly scheduling
schedulePeriod?: numberProperty Value
number
scheduleStartTime
The time to start the schedule
scheduleStartTime?: stringProperty Value
string
scheduleType
The type of schedule
scheduleType: ScheduleTypeProperty Value
ScheduleType
scheduleWeekdays
The weekdays that are selected for scheduling for daily/weekly/monthly schedule type
scheduleWeekdays: WeekdaysItem[]Property Value
WeekdaysItem[]
scheduleWeekIndex
The week that is specified for monthly schedule with relative monthly option
scheduleWeekIndex?: numberProperty Value
number