Skip to content

Commit

Permalink
add missing javaDocStrings
Browse files Browse the repository at this point in the history
  • Loading branch information
linuxpi committed May 9, 2024
1 parent a304615 commit 0032588
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,66 +25,66 @@ public interface TaskClient {
/**
* Submit a new task to TaskStore/Queue
*
* @param task
* @param task Task to be submitted for execution on offline nodes
*/
void submitTask(Task task);

/**
* Claim task from TaskStore/Queue. This ensures no 2 Offline Nodes work on the same task.
*
* @param taskId
* @param taskId TaskId of the task to be claimed
*/
void claimTask(TaskId taskId);

/**
* Get task from TaskStore/Queue
*
* @param taskId
* @param taskId TaskId of the task to be retrieved
* @return Task corresponding to TaskId
*/
Task getTask(TaskId taskId);

/**
* Update task in TaskStore/Queue
*
* @param task
* @param task Task to be updated
*/
void updateTask(Task task);

/**
* Mark task as cancelled.
* Ongoing Tasks can be cancelled as well if the corresponding worker supports cancellation
*
* @param taskId
* @param taskId TaskId of the task to be cancelled
*/
void cancelTask(TaskId taskId);

/**
* List all unassigned tasks
*
* @return
* @return list of all the task which are note not assigned to any worker
*/
List<Task> getUnassignedTasks();

/**
* List all active tasks
*
* @return
* @return list of all the task which are running on any worker
*/
List<Task> getActiveTasks();

/**
* List all completed tasks
*
* @return
* @return list of all the task which have completed execution
*/
List<Task> getCompletedTasks();

/**
* Sends task heart beat to Task Store/Queue
*
* @param taskId
* @param timestamp
* @param taskId TaskId of Task to send heartbeat for
* @param timestamp timestamp of heartbeat to be recorded in TaskStore/Queue
*/
void sendTaskHeartbeat(TaskId taskId, long timestamp);
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public class TaskId {

/**
* Constructor to initialize TaskId
* @param id
* @param id String value of Task id
*/
public TaskId(String id) {
this.id = id;
Expand Down

0 comments on commit 0032588

Please sign in to comment.