SourceSchedule

public struct SourceSchedule : Codable, Equatable

Object containing the schedule information for the source.

  • 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.
    See more

    Declaration

    Swift

    public enum Frequency : String

  • 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.

    Declaration

    Swift

    public var enabled: Bool?

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

    Declaration

    Swift

    public var timeZone: 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.

    Declaration

    Swift

    public var frequency: String?

  • Initialize a SourceSchedule with member variables.

    Declaration

    Swift

    public init(
    enabled: Bool? = nil,
    timeZone: String? = nil,
    frequency: String? = nil
)

    Parameters

    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.
    timeZone

    The time zone to base source crawl times on. Possible values correspond to the IANA (Internet Assigned Numbers Authority) time zones list.
    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.

    Return Value

    An initialized SourceSchedule.