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 class	SourceSchedule.Builder Builder.
static interface	SourceSchedule.Frequency The crawl schedule in the specified **time_zone**.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	enabled
protected java.lang.String	frequency
protected java.lang.String	timeZone

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	enabled() Gets the enabled.
java.lang.String	frequency() Gets the frequency.
SourceSchedule.Builder	newBuilder() New builder.
java.lang.String	timeZone() Gets 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

Field Detail

enabled

protected java.lang.Boolean enabled

timeZone

@SerializedName(value="time_zone")
protected java.lang.String timeZone

frequency

protected java.lang.String frequency

Constructor Detail

SourceSchedule

protected SourceSchedule(SourceSchedule.Builder builder)

Method Detail

newBuilder

public SourceSchedule.Builder newBuilder()

New builder.

Returns:

a SourceSchedule builder

enabled

public java.lang.Boolean enabled()

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

timeZone

public java.lang.String timeZone()

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

frequency

public java.lang.String frequency()

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