com.google.appengine.tools.mapreduce.impl.shardedjob

Interface ShardedJobService

public interface ShardedJobService

Allows interaction with sharded jobs.

Author:

ohler@google.com (Christian Ohler)

Method Summary

Methods

Modifier and Type	Method and Description
void	abortJob(String jobId) Aborts execution of the job with the given ID.
boolean	cleanupJob(String jobId) Deletes all data of a completed job with the given ID.
ShardedJobState	getJobState(String jobId) Returns the state of the job with the given ID.
Iterator<IncrementalTaskState<IncrementalTask>>	lookupTasks(ShardedJobState state) Returns the tasks associated with this ShardedJob.
<T extends IncrementalTask> void	startJob(String jobId, List<? extends T> initialTasks, ShardedJobController<T> controller, ShardedJobSettings settings) Starts a new sharded job with the given ID and parameters.

Method Detail

startJob

<T extends IncrementalTask> void startJob(String jobId,
                                        List<? extends T> initialTasks,
                                        ShardedJobController<T> controller,
                                        ShardedJobSettings settings)

Starts a new sharded job with the given ID and parameters. The ID must be unique. This method is idempotent -- if another invocation of this method aborted (or is in an unknown state, possibly still running or completed), starting the job can be retried by calling the method again with the same arguments. The job won't start twice unless cleanupJob(java.lang.String) is called in between.

Type Parameters:

T - type of tasks that the job consists of

getJobState

ShardedJobState getJobState(String jobId)

Returns the state of the job with the given ID. Returns null if no such job exists.

lookupTasks

Iterator<IncrementalTaskState<IncrementalTask>> lookupTasks(ShardedJobState state)

Returns the tasks associated with this ShardedJob.

abortJob

void abortJob(String jobId)

Aborts execution of the job with the given ID. If the job has already finished or does not exist, this is a no-op.

cleanupJob

boolean cleanupJob(String jobId)

Deletes all data of a completed job with the given ID. Data is being deleted asynchronously. Returns true if job was already deleted or asynchronous task was submitted successfully.