SourceOptions Structure Reference


                    
                    
                    folders

Array of folders to crawl from the Box source. Only valid, and required, when the type field of the source object is set to box.

Declaration

Swift

public var folders: [SourceOptionsFolder]?


                    
                    
                    objects

Array of Salesforce document object types to crawl from the Salesforce source. Only valid, and required, when the type field of the source object is set to salesforce.

Declaration

Swift

public var objects: [SourceOptionsObject]?


                    
                    
                    siteCollections

Array of Microsoft SharePointoint Online site collections to crawl from the SharePoint source. Only valid and required when the type field of the source object is set to sharepoint.

Declaration

Swift

public var siteCollections: [SourceOptionsSiteColl]?


                    
                    
                    urls

Array of Web page URLs to begin crawling the web from. Only valid and required when the type field of the source object is set to web_crawl.

Declaration

Swift

public var urls: [SourceOptionsWebCrawl]?


                    
                    
                    buckets

Array of cloud object store buckets to begin crawling. Only valid and required when the type field of the source object is set to cloud_object_store, and the crawl_all_buckets field is false or not specified.

Declaration

Swift

public var buckets: [SourceOptionsBuckets]?


                    
                    
                    crawlAllBuckets

When true, all buckets in the specified cloud object store are crawled. If set to true, the buckets array must not be specified.

Declaration

Swift

public var crawlAllBuckets: Bool?


                    
                    
                    init(folders:objects:siteCollections:urls:buckets:crawlAllBuckets:)

Initialize a SourceOptions with member variables.

Declaration

Swift

public init(
    folders: [SourceOptionsFolder]? = nil,
    objects: [SourceOptionsObject]? = nil,
    siteCollections: [SourceOptionsSiteColl]? = nil,
    urls: [SourceOptionsWebCrawl]? = nil,
    buckets: [SourceOptionsBuckets]? = nil,
    crawlAllBuckets: Bool? = nil
)

Parameters

`folders`	Array of folders to crawl from the Box source. Only valid, and required, when the type field of the source object is set to `box`.
`objects`	Array of Salesforce document object types to crawl from the Salesforce source. Only valid, and required, when the type field of the source object is set to `salesforce`.
`siteCollections`	Array of Microsoft SharePointoint Online site collections to crawl from the SharePoint source. Only valid and required when the type field of the source object is set to `sharepoint`.
`urls`	Array of Web page URLs to begin crawling the web from. Only valid and required when the type field of the source object is set to `web_crawl`.
`buckets`	Array of cloud object store buckets to begin crawling. Only valid and required when the type field of the source object is set to `cloud_object_store`, and the crawl_all_buckets field is `false` or not specified.
`crawlAllBuckets`	When `true`, all buckets in the specified cloud object store are crawled. If set to `true`, the buckets array must not be specified.

Return Value

An initialized SourceOptions.