ApiSchedule (Cloudera Manager API (4.6.0))

java.lang.Object
- com.cloudera.api.model.ApiSchedule<T>

Direct Known Subclasses:

ApiReplicationSchedule
```
public abstract class ApiSchedule<T extends ApiCommand>
extends Object
```
Base class for commands that can be scheduled in Cloudera Manager.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ApiSchedule()`
`protected`	`ApiSchedule(Long id, Date startTime, Date endTime, long interval, ApiScheduleInterval intervalUnit, boolean paused)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`boolean`	`getAlertOnAbort()` Whether to alert on abort of the scheduled activity.
`boolean`	`getAlertOnFail()` Whether to alert on failure of the scheduled activity.
`boolean`	`getAlertOnStart()` Whether to alert on start of the scheduled activity.
`boolean`	`getAlertOnSuccess()` Whether to alert on successful completion of the scheduled activity.
`Date`	`getEndTime()` The time after which the scheduled activity will no longer be triggered.
`List<T>`	`getHistory()` History of executions of this schedule, sorted in reverse chronological order.
`Long`	`getId()` The schedule id.
`long`	`getInterval()` The duration between consecutive triggers of a scheduled activity.
`ApiScheduleInterval`	`getIntervalUnit()` The unit for the repeat interval.
`Date`	`getNextRun()` Readonly.
`Date`	`getStartTime()` The time at which the scheduled activity is triggered for the first time.
`int`	`hashCode()`
`boolean`	`isPaused()` The paused state for the schedule.
`void`	`setAlertOnAbort(boolean alertOnAbort)`
`void`	`setAlertOnFail(boolean alertOnFail)`
`void`	`setAlertOnStart(boolean alertOnStart)`
`void`	`setAlertOnSuccess(boolean alertOnSuccess)`
`void`	`setEndTime(Date endTime)`
`void`	`setHistory(List<T> history)`
`void`	`setId(Long id)`
`void`	`setInterval(long interval)`
`void`	`setIntervalUnit(ApiScheduleInterval intervalUnit)`
`void`	`setNextRun(Date nextRun)`
`void`	`setPaused(boolean paused)`
`void`	`setStartTime(Date startTime)`
`String`	`toString()`
`protected com.google.common.base.Objects.ToStringHelper`	`toStringHelper()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiSchedule
```
protected ApiSchedule()
```

ApiSchedule

protected ApiSchedule(Long id,
           Date startTime,
           Date endTime,
           long interval,
           ApiScheduleInterval intervalUnit,
           boolean paused)

Method Detail
- getId
```
public Long getId()
```
  The schedule id.
- setId
```
public void setId(Long id)
```
- getStartTime
```
public Date getStartTime()
```
  The time at which the scheduled activity is triggered for the first time.
- setStartTime
```
public void setStartTime(Date startTime)
```
- getEndTime
```
public Date getEndTime()
```
  The time after which the scheduled activity will no longer be triggered.
- setEndTime
```
public void setEndTime(Date endTime)
```
- getInterval
```
public long getInterval()
```
  The duration between consecutive triggers of a scheduled activity.
- setInterval
```
public void setInterval(long interval)
```
- getIntervalUnit
```
public ApiScheduleInterval getIntervalUnit()
```
  The unit for the repeat interval.
- setIntervalUnit
```
public void setIntervalUnit(ApiScheduleInterval intervalUnit)
```
- getNextRun
```
public Date getNextRun()
```
  Readonly. The time the scheduled command will run next.
- setNextRun
```
public void setNextRun(Date nextRun)
```
- getHistory
```
public List<T> getHistory()
```
  History of executions of this schedule, sorted in reverse chronological order.
- setHistory
```
public void setHistory(List<T> history)
```
- isPaused
```
public boolean isPaused()
```
  The paused state for the schedule. The scheduled activity will not be triggered as long as the scheduled is paused.
- setPaused
```
public void setPaused(boolean paused)
```
- getAlertOnStart
```
public boolean getAlertOnStart()
```
  Whether to alert on start of the scheduled activity.
- setAlertOnStart
```
public void setAlertOnStart(boolean alertOnStart)
```
- getAlertOnSuccess
```
public boolean getAlertOnSuccess()
```
  Whether to alert on successful completion of the scheduled activity.
- setAlertOnSuccess
```
public void setAlertOnSuccess(boolean alertOnSuccess)
```
- getAlertOnFail
```
public boolean getAlertOnFail()
```
  Whether to alert on failure of the scheduled activity.
- setAlertOnFail
```
public void setAlertOnFail(boolean alertOnFail)
```
- getAlertOnAbort
```
public boolean getAlertOnAbort()
```
  Whether to alert on abort of the scheduled activity.
- setAlertOnAbort
```
public void setAlertOnAbort(boolean alertOnAbort)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- toStringHelper
```
protected com.google.common.base.Objects.ToStringHelper toStringHelper()
```
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object

Class ApiSchedule<T extends ApiCommand>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiSchedule

ApiSchedule

Method Detail

getId

setId

getStartTime

setStartTime

getEndTime

setEndTime

getInterval

setInterval

getIntervalUnit

setIntervalUnit

getNextRun

setNextRun

getHistory

setHistory

isPaused

setPaused

getAlertOnStart

setAlertOnStart

getAlertOnSuccess

setAlertOnSuccess

getAlertOnFail

setAlertOnFail

getAlertOnAbort

setAlertOnAbort

toString

toStringHelper

equals

hashCode