com.cloudera.api.model

Class ApiReplicationSchedule

java.lang.Object

com.cloudera.api.model.ApiSchedule

com.cloudera.api.model.ApiReplicationSchedule

public class ApiReplicationSchedule
extends ApiSchedule

A replication job schedule.

Replication jobs have service-specific arguments. This object has methods to retrieve arguments for all supported types of replication, but only one argument type is allowed to be set; the backend will check that the provided argument matches the service type where the replication is being scheduled.

The replication job's arguments should match the underlying service. Refer to each property's documentation to find out which properties correspond to which services.

Constructor Summary

Constructors

Constructor and Description
ApiReplicationSchedule()
ApiReplicationSchedule(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)
ApiHdfsReplicationArguments	getHdfsArguments() Arguments for HDFS replication commands.
List<ApiReplicationCommand>	getHistory() List of active and/or finished commands for this schedule.
ApiHiveReplicationArguments	getHiveArguments() Arguments for Hive replication commands.
int	hashCode()
Boolean	isActive() Read-only field that is true if this schedule is currently active, false if not.
void	setActive(Boolean active)
void	setHdfsArguments(ApiHdfsReplicationArguments hdfsArguments)
void	setHistory(List<ApiReplicationCommand> history)
void	setHiveArguments(ApiHiveReplicationArguments hiveArguments)
String	toString()

Methods inherited from class com.cloudera.api.model.ApiSchedule

getAlertOnAbort, getAlertOnFail, getAlertOnStart, getAlertOnSuccess, getEndTime, getId, getInterval, getIntervalUnit, getNextRun, getStartTime, isPaused, setAlertOnAbort, setAlertOnFail, setAlertOnStart, setAlertOnSuccess, setEndTime, setId, setInterval, setIntervalUnit, setNextRun, setPaused, setStartTime, toStringHelper

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiReplicationSchedule

public ApiReplicationSchedule()

ApiReplicationSchedule

public ApiReplicationSchedule(Long id,
                      Date startTime,
                      Date endTime,
                      long interval,
                      ApiScheduleInterval intervalUnit,
                      boolean paused)

Method Detail

getHdfsArguments

public ApiHdfsReplicationArguments getHdfsArguments()

Arguments for HDFS replication commands.

setHdfsArguments

public void setHdfsArguments(ApiHdfsReplicationArguments hdfsArguments)

getHiveArguments

public ApiHiveReplicationArguments getHiveArguments()

Arguments for Hive replication commands.

setHiveArguments

public void setHiveArguments(ApiHiveReplicationArguments hiveArguments)

getHistory

public List<ApiReplicationCommand> getHistory()

List of active and/or finished commands for this schedule.

setHistory

public void setHistory(List<ApiReplicationCommand> history)

isActive

public Boolean isActive()

Read-only field that is true if this schedule is currently active, false if not. Available since API v11.

setActive

public void setActive(Boolean active)

equals

public boolean equals(Object o)

Overrides:

equals in class ApiSchedule

hashCode

public int hashCode()

Overrides:

hashCode in class ApiSchedule

toString

public String toString()

Overrides:

toString in class ApiSchedule