Options
All
  • Public
  • Public/Protected
  • All
Menu

Module UpdateJobDetails

Job properties that can be updated.

Properties

Optional connectionKey

connectionKey: undefined | string

The key of the connection resource that is used for the harvest by this job.

Optional description

description: undefined | string

Detailed description of the job.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional scheduleCronExpression

scheduleCronExpression: undefined | string

Schedule specified in the cron expression format that has seven fields for second, minute, hour, day-of-month, month, day-of-week, year. It can also include special characters like * for all and ? for any. There are also pre-defined schedules that can be specified using special strings. For example, @hourly will run the job every hour.

Optional timeScheduleBegin

timeScheduleBegin: Date

Date that the schedule should be operational. An RFC3339 formatted datetime string.

Optional timeScheduleEnd

timeScheduleEnd: Date

Date that the schedule should end from being operational. An RFC3339 formatted datetime string.

Functions

getJsonObj