com.ibm.watson.discovery.v1.model

Class SourceSchedule

java.lang.Object

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

com.ibm.watson.discovery.v1.model.SourceSchedule

All Implemented Interfaces:

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

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

Object containing the schedule information for the source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceSchedule.Frequency The crawl schedule in the specified **time_zone**.

Constructor Summary

Constructors

Constructor and Description
SourceSchedule()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFrequency() Gets the frequency.
java.lang.String	getTimeZone() Gets the timeZone.
java.lang.Boolean	isEnabled() Gets the enabled.
void	setEnabled(java.lang.Boolean enabled) Sets the enabled.
void	setFrequency(java.lang.String frequency) Sets the frequency.
void	setTimeZone(java.lang.String timeZone) Sets the timeZone.

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

SourceSchedule

public SourceSchedule()

Method Detail

isEnabled

public java.lang.Boolean isEnabled()

Gets the enabled. When `true`, the source is re-crawled based on the **frequency** field in this object. When `false` the source is not re-crawled; When `false` and connecting to Salesforce the source is crawled annually.

Returns:

the enabled

getTimeZone

public java.lang.String getTimeZone()

Gets the timeZone. The time zone to base source crawl times on. Possible values correspond to the IANA (Internet Assigned Numbers Authority) time zones list.

Returns:

the timeZone

getFrequency

public java.lang.String getFrequency()

Gets the frequency. The crawl schedule in the specified **time_zone**. - `five_minutes`: Runs every five minutes. - `hourly`: Runs every hour. - `daily`: Runs every day between 00:00 and 06:00. - `weekly`: Runs every week on Sunday between 00:00 and 06:00. - `monthly`: Runs the on the first Sunday of every month between 00:00 and 06:00.

Returns:

the frequency

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Sets the enabled.

Parameters:

enabled - the new enabled

setTimeZone

public void setTimeZone(java.lang.String timeZone)

Sets the timeZone.

Parameters:

timeZone - the new timeZone

setFrequency

public void setFrequency(java.lang.String frequency)

Sets the frequency.

Parameters:

frequency - the new frequency