Source

public struct Source : Codable, Equatable

Object containing source parameters for the configuration.

  • The type of source to connect to.

    • box indicates the configuration is to connect an instance of Enterprise Box.
    • salesforce indicates the configuration is to connect to Salesforce.
    • sharepoint indicates the configuration is to connect to Microsoft SharePoint Online.
    • web_crawl indicates the configuration is to perform a web page crawl.
    • cloud_object_storage indicates the configuration is to connect to a cloud object store.
    See more

    Declaration

    Swift

    public enum TypeEnum : String

  • The type of source to connect to.

    • box indicates the configuration is to connect an instance of Enterprise Box.
    • salesforce indicates the configuration is to connect to Salesforce.
    • sharepoint indicates the configuration is to connect to Microsoft SharePoint Online.
    • web_crawl indicates the configuration is to perform a web page crawl.
    • cloud_object_storage indicates the configuration is to connect to a cloud object store.

    Declaration

    Swift

    public var type: String?

  • The credential_id of the credentials to use to connect to the source. Credentials are defined using the credentials method. The source_type of the credentials used must match the type field specified in this object.

    Declaration

    Swift

    public var credentialID: String?

  • Object containing the schedule information for the source.

    Declaration

    Swift

    public var schedule: SourceSchedule?

  • The options object defines which items to crawl from the source system.

    Declaration

    Swift

    public var options: SourceOptions?

  • Initialize a Source with member variables.

    Declaration

    Swift

    public init(
    type: String? = nil,
    credentialID: String? = nil,
    schedule: SourceSchedule? = nil,
    options: SourceOptions? = nil
)

    Parameters

    type

    The type of source to connect to.

    • box indicates the configuration is to connect an instance of Enterprise Box.
    • salesforce indicates the configuration is to connect to Salesforce.
    • sharepoint indicates the configuration is to connect to Microsoft SharePoint Online.
    • web_crawl indicates the configuration is to perform a web page crawl.
    • cloud_object_storage indicates the configuration is to connect to a cloud object store.
    credentialID

    The credential_id of the credentials to use to connect to the source. Credentials are defined using the credentials method. The source_type of the credentials used must match the type field specified in this object.
    schedule

    Object containing the schedule information for the source.
    options

    The options object defines which items to crawl from the source system.

    Return Value

    An initialized Source.