com.cloudera.api.v3

Interface ReplicationsResource

All Known Subinterfaces:

ReplicationsResourceV11, ReplicationsResourceV13, ReplicationsResourceV4

public interface ReplicationsResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiReplicationScheduleList	createSchedules(ApiReplicationScheduleList schedules) Creates one or more replication schedules.
ApiReplicationScheduleList	deleteAllSchedules() Deletes all existing replication schedules.
ApiReplicationSchedule	deleteSchedule(long scheduleId) Deletes an existing replication schedule.
ApiReplicationSchedule	readSchedule(long scheduleId, DataView dataView) Returns information for a specific replication schedule.
ApiReplicationScheduleList	readSchedules(DataView dataView) Returns information for all replication schedules.
ApiCommand	runSchedule(long scheduleId, boolean dryRun) Run the schedule immediately.
ApiReplicationSchedule	updateSchedule(long scheduleId, ApiReplicationSchedule schedule) Updates an existing replication schedule.

Method Detail

createSchedules

@Path(value="/")
ApiReplicationScheduleList createSchedules(ApiReplicationScheduleList schedules)

Creates one or more replication schedules.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

schedules - List of the replication schedules to create.

Returns:

List of newly added replication schedules.

readSchedules

@Path(value="/")
ApiReplicationScheduleList readSchedules(DataView dataView)

Returns information for all replication schedules.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

dataView - The view to materialize.

Returns:

List of replication schedules.

readSchedule

@Path(value="/{scheduleId}")
ApiReplicationSchedule readSchedule(long scheduleId,
                                       DataView dataView)

Returns information for a specific replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

scheduleId - Id of an existing replication schedule.

dataView - The view to materialize.

Returns:

Replication schedule.

updateSchedule

@Path(value="/{scheduleId}")
ApiReplicationSchedule updateSchedule(long scheduleId,
                                         ApiReplicationSchedule schedule)

Updates an existing replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

scheduleId - Id of an existing replication schedule.

Returns:

The replication schedule after the update.

deleteSchedule

@Path(value="/{scheduleId}")
ApiReplicationSchedule deleteSchedule(long scheduleId)

Deletes an existing replication schedule.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

scheduleId - Id of an existing replication schedule.

Returns:

The deleted replication schedule.

deleteAllSchedules

@Path(value="/")
ApiReplicationScheduleList deleteAllSchedules()

Deletes all existing replication schedules.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Returns:

List of deleted replication schedules.

runSchedule

@Path(value="/{scheduleId}/run")
ApiCommand runSchedule(long scheduleId,
                          boolean dryRun)

Run the schedule immediately.

The replication command will be triggered with the configured arguments, and will be recorded in the schedule's history.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters:

scheduleId - Id of an existing replication schedule.

dryRun - Whether to execute a dry run.

Returns:

Information about the submitted command.