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.

Constructor Summary

Constructors

Constructor and Description
SourceOptions()

Method Summary

Modifier and Type	Method and Description
java.util.List<SourceOptionsBuckets>	getBuckets() Gets the buckets.
java.util.List<SourceOptionsFolder>	getFolders() Gets the folders.
java.util.List<SourceOptionsObject>	getObjects() Gets the objects.
java.util.List<SourceOptionsSiteColl>	getSiteCollections() Gets the siteCollections.
java.util.List<SourceOptionsWebCrawl>	getUrls() Gets the urls.
java.lang.Boolean	isCrawlAllBuckets() Gets the crawlAllBuckets.
void	setBuckets(java.util.List<SourceOptionsBuckets> buckets) Sets the buckets.
void	setCrawlAllBuckets(java.lang.Boolean crawlAllBuckets) Sets the crawlAllBuckets.
void	setFolders(java.util.List<SourceOptionsFolder> folders) Sets the folders.
void	setObjects(java.util.List<SourceOptionsObject> objects) Sets the objects.
void	setSiteCollections(java.util.List<SourceOptionsSiteColl> siteCollections) Sets the siteCollections.
void	setUrls(java.util.List<SourceOptionsWebCrawl> urls) Sets the urls.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceOptions

public SourceOptions()

Method Detail

getFolders

public java.util.List<SourceOptionsFolder> getFolders()

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

getObjects

public java.util.List<SourceOptionsObject> getObjects()

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

getSiteCollections

public java.util.List<SourceOptionsSiteColl> getSiteCollections()

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

getUrls

public java.util.List<SourceOptionsWebCrawl> getUrls()

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

getBuckets

public java.util.List<SourceOptionsBuckets> getBuckets()

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

isCrawlAllBuckets

public java.lang.Boolean isCrawlAllBuckets()

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

setFolders

public void setFolders(java.util.List<SourceOptionsFolder> folders)

Sets the folders.

Parameters:

folders - the new folders

setObjects

public void setObjects(java.util.List<SourceOptionsObject> objects)

Sets the objects.

Parameters:

objects - the new objects

setSiteCollections

public void setSiteCollections(java.util.List<SourceOptionsSiteColl> siteCollections)

Sets the siteCollections.

Parameters:

siteCollections - the new siteCollections

setUrls

public void setUrls(java.util.List<SourceOptionsWebCrawl> urls)

Sets the urls.

Parameters:

urls - the new urls

setBuckets

public void setBuckets(java.util.List<SourceOptionsBuckets> buckets)

Sets the buckets.

Parameters:

buckets - the new buckets

setCrawlAllBuckets

public void setCrawlAllBuckets(java.lang.Boolean crawlAllBuckets)

Sets the crawlAllBuckets.

Parameters:

crawlAllBuckets - the new crawlAllBuckets