alluxio.master.job

Class JobMasterClientRestServiceHandler

java.lang.Object

alluxio.master.job.JobMasterClientRestServiceHandler

@Path(value="master/job")
 @Produces(value="application/json")
public final class JobMasterClientRestServiceHandler
extends java.lang.Object

The REST service handler for job master.

Constructor Summary

Constructors

Constructor and Description
JobMasterClientRestServiceHandler(javax.servlet.ServletContext context) Creates a new instance of JobMasterClientRestServiceHandler.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	cancel(long jobId) Cancels a job.
javax.ws.rs.core.Response	getServiceName()
javax.ws.rs.core.Response	getServiceVersion()
javax.ws.rs.core.Response	getStatus(long jobId) Gets the job status.
javax.ws.rs.core.Response	list(java.util.List<java.lang.String> statusList, java.lang.String name) Lists all the jobs in the history.
javax.ws.rs.core.Response	run(JobConfig jobConfig) Runs a job.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMasterClientRestServiceHandler

public JobMasterClientRestServiceHandler(@Context
                                         javax.servlet.ServletContext context)

Creates a new instance of JobMasterClientRestServiceHandler.

Parameters:

context - context for the servlet

Method Detail

getServiceName

@GET
 @Path(value="service_name")
public javax.ws.rs.core.Response getServiceName()

Returns:

the service name

getServiceVersion

@GET
 @Path(value="service_version")
public javax.ws.rs.core.Response getServiceVersion()

Returns:

the service version

cancel

@POST
 @Path(value="cancel")
public javax.ws.rs.core.Response cancel(@QueryParam(value="jobId")
                                                                     long jobId)

Cancels a job.

Parameters:

jobId - the id of the job to cancel

Returns:

the response

getStatus

@GET
 @Path(value="get_status")
public javax.ws.rs.core.Response getStatus(@QueryParam(value="jobId")
                                                                           long jobId)

Gets the job status.

Parameters:

jobId - the job id

Returns:

the response of the job status

list

@GET
 @Path(value="list")
public javax.ws.rs.core.Response list(@QueryParam(value="status")
                                                                java.util.List<java.lang.String> statusList,
                                                                @QueryParam(value="name")
                                                                java.lang.String name)

Lists all the jobs in the history.

Parameters:

statusList - the target status of jobs

name - the name of jobs

Returns:

the response of the names of all the jobs

run

@POST
 @Path(value="run")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response run(JobConfig jobConfig)

Runs a job.

Parameters:

jobConfig - the configuration of the job

Returns:

the job id that tracks the job