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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<SourceOptionsBuckets>	buckets
protected java.lang.Boolean	crawlAllBuckets
protected java.util.List<SourceOptionsFolder>	folders
protected java.util.List<SourceOptionsObject>	objects
protected java.util.List<SourceOptionsSiteColl>	siteCollections
protected java.util.List<SourceOptionsWebCrawl>	urls

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SourceOptions(SourceOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<SourceOptionsBuckets>	buckets() Gets the buckets.
java.lang.Boolean	crawlAllBuckets() Gets the crawlAllBuckets.
java.util.List<SourceOptionsFolder>	folders() Gets the folders.
SourceOptions.Builder	newBuilder() New builder.
java.util.List<SourceOptionsObject>	objects() Gets the objects.
java.util.List<SourceOptionsSiteColl>	siteCollections() Gets the siteCollections.
java.util.List<SourceOptionsWebCrawl>	urls() Gets 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

Field Detail

folders

protected java.util.List<SourceOptionsFolder> folders

objects

protected java.util.List<SourceOptionsObject> objects

siteCollections

@SerializedName(value="site_collections")
protected java.util.List<SourceOptionsSiteColl> siteCollections

urls

protected java.util.List<SourceOptionsWebCrawl> urls

buckets

protected java.util.List<SourceOptionsBuckets> buckets

crawlAllBuckets

@SerializedName(value="crawl_all_buckets")
protected java.lang.Boolean crawlAllBuckets

Constructor Detail

SourceOptions

protected SourceOptions(SourceOptions.Builder builder)

Method Detail

newBuilder

public SourceOptions.Builder newBuilder()

New builder.

Returns:

a SourceOptions builder

folders

public java.util.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 java.util.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 java.util.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 java.util.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 java.util.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 java.lang.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