org.apache.samza.rest.resources

Class TasksResource

java.lang.Object

org.apache.samza.rest.resources.TasksResource

@Singleton
 @Path(value="/v1/jobs")
public class TasksResource
extends java.lang.Object

The REST resource for tasks. Handles the requests that are at the tasks scope.

Constructor Summary

Constructors

Constructor and Description
TasksResource(TaskResourceConfig config) Initializes a TaskResource with TaskProxy from the TaskProxyFactory class specified in the configuration.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getTasks(java.lang.String jobName, java.lang.String jobId) Gets the list of Task for the job instance specified by jobName and jobId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TasksResource

public TasksResource(TaskResourceConfig config)

Initializes a TaskResource with TaskProxy from the TaskProxyFactory class specified in the configuration.

Parameters:

config - the configuration containing the TaskProxyFactory class.

Method Detail

getTasks

@GET
 @Path(value="/{jobName}/{jobId}/tasks")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getTasks(@PathParam(value="jobName")
                                                                                                                             java.lang.String jobName,
                                                                                                                             @PathParam(value="jobId")
                                                                                                                             java.lang.String jobId)

Gets the list of Task for the job instance specified by jobName and jobId.

Parameters:

jobName - the name of the job as configured in JobConfig.JOB_NAME

jobId - the id of the job as configured in JobConfig.JOB_ID.

Returns:

a Response.Status.OK Response contains a list of Task, where each task belongs to the samza job. Response.Status.BAD_REQUEST is returned for invalid job instances.