com.ibm.watson.discovery.v1.model

Class Source

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v1.model.Source

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class Source
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Object containing source parameters for the configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Source.Builder Builder.
static interface	Source.Type The type of source to connect to.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	credentialId
protected SourceOptions	options
protected SourceSchedule	schedule
protected java.lang.String	type

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	credentialId() Gets the credentialId.
Source.Builder	newBuilder() New builder.
SourceOptions	options() Gets the options.
SourceSchedule	schedule() Gets the schedule.
java.lang.String	type() Gets the type.

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

type

protected java.lang.String type

credentialId

@SerializedName(value="credential_id")
protected java.lang.String credentialId

schedule

protected SourceSchedule schedule

options

protected SourceOptions options

Constructor Detail

Source

protected Source(Source.Builder builder)

Method Detail

newBuilder

public Source.Builder newBuilder()

New builder.

Returns:

a Source builder

type

public java.lang.String type()

Gets the 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.

Returns:

the type

credentialId

public java.lang.String credentialId()

Gets the 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.

Returns:

the credentialId

schedule

public SourceSchedule schedule()

Gets the schedule.

Object containing the schedule information for the source.

Returns:

the schedule

options

public SourceOptions options()

Gets the options.

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

Returns:

the options