com.iland.core.web.rest.api

Interface VacJobResource

@Path(value="/vac-jobs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VacJobResource

VAC Job Resource

Author:

Sachin Mittal

Method Summary

Modifier and Type	Method and Description
TaskResponse	disableVacJob(String jobUuid) Disable a VAC job.
TaskResponse	enableVacJob(String jobUuid) Enable a VAC job.
BaJobResponse	getVacJob(String jobUuid) Get a VAC job given a VAC company uuid and the job's uuid.
BaJobListResponse	getVacJobHistory(String jobUuid, Long start, Long end) Get the history for a VAC job given a start and end date.
TaskResponse	retryVacJob(String jobUuid) Retry a VAC job.
TaskResponse	startVacJob(String jobUuid) Start a VAC job.
TaskResponse	stopVacJob(String jobUuid) Stop a VAC job.

Method Detail

getVacJob

@GET
 @Path(value="/{jobUuid}")
BaJobResponse getVacJob(@PathParam(value="jobUuid")
                                                        String jobUuid)

Get a VAC job given a VAC company uuid and the job's uuid.

Parameters:

jobUuid - the job UUID of vac company

Returns:

a list of vac jobs for the given company

enableVacJob

@POST
 @Path(value="/{jobUuid}/action/enable")
TaskResponse enableVacJob(@PathParam(value="jobUuid")
                                                                         String jobUuid)

Enable a VAC job.

Parameters:

jobUuid - the job UUID of vac job

Returns:

a core task

disableVacJob

@POST
 @Path(value="/{jobUuid}/action/disable")
TaskResponse disableVacJob(@PathParam(value="jobUuid")
                                                                           String jobUuid)

Disable a VAC job.

Parameters:

jobUuid - the job UUID of vac job

Returns:

a core task

startVacJob

@POST
 @Path(value="/{jobUuid}/action/start")
TaskResponse startVacJob(@PathParam(value="jobUuid")
                                                                       String jobUuid)

Start a VAC job.

Parameters:

jobUuid - the job UUID of vac job

Returns:

a message indicating that the VAC job was started

stopVacJob

@POST
 @Path(value="/{jobUuid}/action/stop")
TaskResponse stopVacJob(@PathParam(value="jobUuid")
                                                                     String jobUuid)

Stop a VAC job.

Parameters:

jobUuid - the job UUID of vac job

Returns:

a message indicating that the VAC job was stopped

retryVacJob

@POST
 @Path(value="/{jobUuid}/action/retry")
TaskResponse retryVacJob(@PathParam(value="jobUuid")
                                                                       String jobUuid)

Retry a VAC job.

Parameters:

jobUuid - the job UUID of vac job

Returns:

a message indicating that the VAC job was retried

getVacJobHistory

@GET
 @Path(value="/{jobUuid}/history")
BaJobListResponse getVacJobHistory(@PathParam(value="jobUuid")
                                                                           String jobUuid,
                                                                           @QueryParam(value="start")
                                                                           Long start,
                                                                           @QueryParam(value="end")
                                                                           Long end)

Get the history for a VAC job given a start and end date. If start or end is not passed then it defaults start to a week ago and sets end as current time.

Parameters:

jobUuid - the job UUID of vac job

start - the start of the vac job history

end - the end of the vac job history

Returns:

the vac job's history