Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SourceSchedule

Object containing the schedule information for the source.

Hierarchy

  • SourceSchedule

Index

Properties

Optional enabled

enabled: boolean

When true, the source is re-crawled based on the frequency field in this object. When false the source is not re-crawled; When false and connecting to Salesforce the source is crawled annually.

Optional frequency

frequency: string

The crawl schedule in the specified time_zone.

  • five_minutes: Runs every five minutes.
  • hourly: Runs every hour.
  • daily: Runs every day between 00:00 and 06:00.
  • weekly: Runs every week on Sunday between 00:00 and 06:00.
  • monthly: Runs the on the first Sunday of every month between 00:00 and 06:00.

Optional time_zone

time_zone: string

The time zone to base source crawl times on. Possible values correspond to the IANA (Internet Assigned Numbers Authority) time zones list.

Generated using TypeDoc