org.apache.lens.server.scheduler

Class ScheduleResource

java.lang.Object

org.apache.lens.server.scheduler.ScheduleResource

@Path(value="scheduler")
 @Produces(value={"application/json","application/xml"})
public class ScheduleResource
extends Object

REST end point for all scheduler operations.

Constructor Summary

Constructors

Constructor and Description
ScheduleResource()

Method Summary

Modifier and Type	Method and Description
LensAPIResult	deleteJob(LensSessionHandle sessionId, SchedulerJobHandle jobHandle) Marks the job for deletion.
List<SchedulerJobHandle>	getAllJobs(LensSessionHandle sessionHandle, String user, SchedulerJobState state, Long start, Long end) Get all job handles matching user, state and end_time >job_submission_time >=start time.
Collection<SchedulerJobStats>	getAllJobStats(LensSessionHandle sessionId, String status, String jobName, String user, long start, long end) Get all job stats
LensAPIResult<SchedulerJobInstanceInfo>	getInstanceDetails(LensSessionHandle sessionId, SchedulerJobInstanceHandle instanceHandle) Returns a SchedulerInstanceInfo for a given instance handle.
LensAPIResult<XJob>	getJobDefinition(LensSessionHandle sessionId, SchedulerJobHandle jobHandle) Get XJob definition for a given job handle.
LensAPIResult<SchedulerJobInfo>	getJobDetails(LensSessionHandle sessionId, SchedulerJobHandle jobHandle) Returns the SchedulerJobInfo of a given job handle.
List<SchedulerJobInstanceInfo>	getJobInstances(LensSessionHandle sessionId, SchedulerJobHandle jobHandle, Long numResults) Returns all the instances of a job.
String	getMessage()
LensAPIResult<SchedulerJobHandle>	submitJob(LensSessionHandle sessionId, String action, XJob job) Submits a job to be scheduled at later point of time or submit and schedule simultaneously.
LensAPIResult	updateInstance(LensSessionHandle sessionId, SchedulerJobInstanceHandle instanceHandle, String action) Updates an instance
LensAPIResult	updateJob(LensSessionHandle sessionId, SchedulerJobHandle jobHandle, String action) Changes the job state
LensAPIResult	updateJob(LensSessionHandle sessionId, SchedulerJobHandle jobHandle, XJob job) Updates job definition of an existing job.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleResource

public ScheduleResource()

Method Detail

getMessage

@GET
 @Produces(value="text/plain")
public String getMessage()

submitJob

@POST
 @Consumes(value={"application/xml","application/json"})
 @Path(value="jobs")
public LensAPIResult<SchedulerJobHandle> submitJob(@QueryParam(value="sessionid")
                                                                                                                                       LensSessionHandle sessionId,
                                                                                                                                       @QueryParam(value="action")
                                                                                                                                       String action,
                                                                                                                                       XJob job)
                                                                                                                                throws LensException

Submits a job to be scheduled at later point of time or submit and schedule simultaneously.

Parameters:

sessionId - Session ID, the logged-in user will be set as the owner of this job

action - Action could be submit for storing the job or it could be "submit-and-schedule" to schedule it just after submitting the job.

job - XJob definition of the job to be submitted

Returns:

A newly generated job handle for the job. Job handle is the unique ID of a job.

Throws:

LensException

getAllJobs

@GET
 @Path(value="jobs")
public List<SchedulerJobHandle> getAllJobs(@QueryParam(value="sessionid")
                                                                     LensSessionHandle sessionHandle,
                                                                     @QueryParam(value="user")
                                                                     String user,
                                                                     @QueryParam(value="state")
                                                                     SchedulerJobState state,
                                                                     @QueryParam(value="start")
                                                                     Long start,
                                                                     @QueryParam(value="end")
                                                                     Long end)
                                                              throws LensException

Get all job handles matching user, state and end_time >job_submission_time >=start time. If any of the values are null, it will not be considered while filtering. For example: user is "test" and state is null then it will return job handles irrespective of state of the job.

Parameters:

sessionHandle - Session ID

user - User of the job

state - State of job: for example: SUCCEED or EXPIRED

start - Submission time should be grater than or equal to start time

end - Submission time should be strictly less than the end time.

Returns:

A list of all jobs matching the filtering criteria.

Throws:

LensException

getAllJobStats

@GET
 @Path(value="jobs/stats")
public Collection<SchedulerJobStats> getAllJobStats(@QueryParam(value="sessionid")
                                                                                    LensSessionHandle sessionId,
                                                                                    @DefaultValue(value="running") @QueryParam(value="status")
                                                                                    String status,
                                                                                    @QueryParam(value="name")
                                                                                    String jobName,
                                                                                    @DefaultValue(value="user") @QueryParam(value="user")
                                                                                    String user,
                                                                                    @DefaultValue(value="-1") @QueryParam(value="start")
                                                                                    long start,
                                                                                    @DefaultValue(value="-1") @QueryParam(value="end")
                                                                                    long end)
                                                                             throws LensException

Get all job stats

Parameters:

sessionId - Session ID

status - Job status

jobName - Name of the job

user - User of the job

start - start time

end - end time

Returns:

A list of SchedulerJobStats

Throws:

LensException

getJobDefinition

@GET
 @Path(value="jobs/{jobHandle}")
public LensAPIResult<XJob> getJobDefinition(@QueryParam(value="sessionid")
                                                                                  LensSessionHandle sessionId,
                                                                                  @PathParam(value="jobHandle")
                                                                                  SchedulerJobHandle jobHandle)
                                                                           throws LensException

Get XJob definition for a given job handle.

Parameters:

sessionId - SessionID

jobHandle - Job handle

Returns:

XJob definition

Throws:

LensException

deleteJob

@DELETE
 @Path(value="jobs/{jobHandle}")
public LensAPIResult deleteJob(@QueryParam(value="sessionid")
                                                                        LensSessionHandle sessionId,
                                                                        @PathParam(value="jobHandle")
                                                                        SchedulerJobHandle jobHandle)
                                                                 throws LensException

Marks the job for deletion. Jobs are not deleted immediately, rather they are marked for deletion. A deleted job is a dormant job which can't be elicited by any action.

Parameters:

sessionId - Session id

jobHandle - Job handle

Returns:

API result

Throws:

LensException

updateJob

@PUT
 @Path(value="jobs/{jobHandle}/")
 @Consumes(value={"application/xml","application/json"})
public LensAPIResult updateJob(@QueryParam(value="sessionid")
                                                                                                                               LensSessionHandle sessionId,
                                                                                                                               @PathParam(value="jobHandle")
                                                                                                                               SchedulerJobHandle jobHandle,
                                                                                                                               XJob job)
                                                                                                                        throws LensException

Updates job definition of an existing job. New definition can have new query and configurations.

Parameters:

sessionId - Session Id

jobHandle - Job handle

job - New job definition.

Returns:

LensAPIResult

Throws:

LensException

updateJob

@POST
 @Path(value="jobs/{jobHandle}")
public LensAPIResult updateJob(@QueryParam(value="sessionid")
                                                                      LensSessionHandle sessionId,
                                                                      @PathParam(value="jobHandle")
                                                                      SchedulerJobHandle jobHandle,
                                                                      @DefaultValue(value="schedule") @QueryParam(value="action")
                                                                      String action)
                                                               throws LensException

Changes the job state

Parameters:

sessionId - Session Id

jobHandle - Job handle

action - An action can be SCHEDULE, EXPIRE, SUSPEND or RESUME

Returns:

LensAPIResult

Throws:

LensException

getJobDetails

@GET
 @Path(value="jobs/{jobHandle}/info")
public LensAPIResult<SchedulerJobInfo> getJobDetails(@QueryParam(value="sessionid")
                                                                                                LensSessionHandle sessionId,
                                                                                                @PathParam(value="jobHandle")
                                                                                                SchedulerJobHandle jobHandle)
                                                                                         throws LensException

Returns the SchedulerJobInfo of a given job handle.

Parameters:

sessionId - Session ID

jobHandle - Job handle

Returns:

SchedulerJobinfo

Throws:

LensException

getJobInstances

@GET
 @Path(value="jobs/{jobHandle}/instances/")
public List<SchedulerJobInstanceInfo> getJobInstances(@QueryParam(value="sessionid")
                                                                                                       LensSessionHandle sessionId,
                                                                                                       @PathParam(value="jobHandle")
                                                                                                       SchedulerJobHandle jobHandle,
                                                                                                       @QueryParam(value="numResults")
                                                                                                       Long numResults)
                                                                                                throws LensException

Returns all the instances of a job.

Parameters:

sessionId - Session id

jobHandle - Job handle

numResults - Number of results to be returned

Returns:

A list of SchedulerInstanceInfo for a given job handle

Throws:

LensException

getInstanceDetails

@GET
 @Path(value="instances/{instanceHandle}")
public LensAPIResult<SchedulerJobInstanceInfo> getInstanceDetails(@QueryParam(value="sessionid")
                                                                                                                  LensSessionHandle sessionId,
                                                                                                                  @PathParam(value="instanceHandle")
                                                                                                                  SchedulerJobInstanceHandle instanceHandle)
                                                                                                           throws LensException

Returns a SchedulerInstanceInfo for a given instance handle.

Parameters:

sessionId - Session ID

instanceHandle - instance handle

Returns:

SchedulerInstanceInfo

Throws:

LensException

updateInstance

@POST
 @Path(value="instances/{instanceHandle}")
public LensAPIResult updateInstance(@QueryParam(value="sessionid")
                                                                                     LensSessionHandle sessionId,
                                                                                     @PathParam(value="instanceHandle")
                                                                                     SchedulerJobInstanceHandle instanceHandle,
                                                                                     @QueryParam(value="action")
                                                                                     String action)
                                                                              throws LensException

Updates an instance

Parameters:

sessionId - Session ID

instanceHandle - Instance handle

action - the value of action could be KILL or RERUN.

Returns:

LensAPIResult

Throws:

LensException