Package com.ibm.watson.discovery.v1.model

Class SourceOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v1.model.SourceOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class SourceOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The **options** object defines which items to crawl from the source system.

  • Method Details

    • newBuilder

      public SourceOptions.Builder newBuilder()
      New builder.
      Returns:
      a SourceOptions builder

    • folders

      public List<SourceOptionsFolder> folders()
      Gets the 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`.

      Returns:
      the folders

    • objects

      public List<SourceOptionsObject> objects()
      Gets the 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`.

      Returns:
      the objects

    • siteCollections

      public List<SourceOptionsSiteColl> siteCollections()
      Gets the 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`.

      Returns:
      the siteCollections

    • urls

      public List<SourceOptionsWebCrawl> urls()
      Gets the 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`.

      Returns:
      the urls

    • buckets

      public List<SourceOptionsBuckets> buckets()
      Gets the 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.

      Returns:
      the buckets

    • crawlAllBuckets

      public Boolean crawlAllBuckets()
      Gets the crawlAllBuckets.

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

      Returns:
      the crawlAllBuckets