org.apache.samza.rest.resources

Class JobsResource

java.lang.Object

org.apache.samza.rest.resources.JobsResource

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

The REST resource for jobs. Handles all requests for the jobs collection or individual job instances.

Constructor Summary

Constructors

Constructor and Description
JobsResource(JobsResourceConfig config) Initializes a JobResource with JobProxy from the JobProxyFactory class specified in the configuration.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getInstalledJobs() Gets the Job for all the jobs installed on this host.
javax.ws.rs.core.Response	getJob(java.lang.String jobName, java.lang.String jobId) Gets the Job for the job instance specified by jobName and jobId if it is installed on this host.
javax.ws.rs.core.Response	updateJobStatus(java.lang.String jobName, java.lang.String jobId, java.lang.String status)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsResource

public JobsResource(JobsResourceConfig config)

Initializes a JobResource with JobProxy from the JobProxyFactory class specified in the configuration.

Parameters:

config - the configuration containing the JobProxyFactory class.

Method Detail

getInstalledJobs

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getInstalledJobs()

Gets the Job for all the jobs installed on this host.

Returns:

a Response.Status.OK Response containing a list of Job for all the installed Samza jobs installed on this host.

getJob

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

Gets the Job for the job instance specified by jobName and jobId if it is installed on this host.

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 containing a Job for the Samza job if it is installed on this host. Response.Status.NOT_FOUND and Response.Status.INTERNAL_SERVER_ERROR can occur for corresponding errors.

updateJobStatus

@PUT
 @Path(value="/{jobName}/{jobId}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateJobStatus(@PathParam(value="jobName")
                                                                                                                              java.lang.String jobName,
                                                                                                                              @PathParam(value="jobId")
                                                                                                                              java.lang.String jobId,
                                                                                                                              @QueryParam(value="status")
                                                                                                                              java.lang.String status)

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().

status - the JobStatus to which the job will transition.

Returns:

a Response.Status.ACCEPTED Response containing a Job for the Samza job if it is installed on this host. Response.Status.NOT_FOUND Response.Status.BAD_REQUEST and Response.Status.INTERNAL_SERVER_ERROR can occur for corresponding errors.