Class SourceSchedule

All Implemented Interfaces:

public class SourceSchedule
Object containing the schedule information for the source.
  • Method Details

    • newBuilder

      public SourceSchedule.Builder newBuilder()
      New builder.
      a SourceSchedule builder
    • enabled

      public Boolean enabled()
      Gets the enabled.

      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.

      the enabled
    • timeZone

      public String timeZone()
      Gets the timeZone.

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

      the timeZone
    • frequency

      public String frequency()
      Gets the frequency.

      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.

      the frequency