com.spotify.helios.master.resources

Class JobsResource

java.lang.Object

com.spotify.helios.master.resources.JobsResource

@Path(value="/jobs")
public class JobsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
JobsResource(MasterModel model, MasterMetrics metrics, Set<String> whitelistedCapabilities)

Method Summary

Modifier and Type	Method and Description
com.spotify.helios.common.protocol.JobDeleteResponse	delete(com.spotify.helios.common.descriptors.JobId id, String token) Deletes the job specified by the given id.
com.google.common.base.Optional<com.spotify.helios.common.descriptors.Job>	get(com.spotify.helios.common.descriptors.JobId id) Returns the Job with the given id.
Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.JobStatus>	jobStatuses(Set<com.spotify.helios.common.descriptors.JobId> ids)
Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Job>	list(String query) Returns a Map of job id to job definition for all jobs known.
com.spotify.helios.common.protocol.CreateJobResponse	post(com.spotify.helios.common.descriptors.Job job, String username) Create a job given the definition in job.
com.google.common.base.Optional<com.spotify.helios.common.descriptors.JobStatus>	statusGet(com.spotify.helios.common.descriptors.JobId id) Returns the job status for the given job id.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsResource

public JobsResource(MasterModel model,
                    MasterMetrics metrics,
                    Set<String> whitelistedCapabilities)

Method Detail

list

@GET
 @Produces(value="application/json")
public Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Job> list(@QueryParam(value="q") @DefaultValue(value="")
                                                                                                                                                 String query)

Returns a Map of job id to job definition for all jobs known. If the query parameter q is specified it will only return jobs whose job id contains the string.

Parameters:

query - The query string.

Returns:

A map of Job IDs to Jobs.

get

@Path(value="{id}")
 @GET
 @Produces(value="application/json")
public com.google.common.base.Optional<com.spotify.helios.common.descriptors.Job> get(@InjectParam @PathParam(value="id")
                                                                                                                                                     com.spotify.helios.common.descriptors.JobId id)

Returns the Job with the given id.

Parameters:

id - The job ID.

Returns:

The job.

post

@POST
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.CreateJobResponse post(com.spotify.helios.common.descriptors.Job job,
                                                                                                            String username)

Create a job given the definition in job.

Parameters:

job - The job to create.

username - The user creating the job.

Returns:

The response.

delete

@Path(value="{id}")
 @DELETE
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.JobDeleteResponse delete(@PathParam(value="id")
                                                                                                                                     com.spotify.helios.common.descriptors.JobId id,
                                                                                                                                     @QueryParam(value="token") @DefaultValue(value="")
                                                                                                                                     String token)

Deletes the job specified by the given id.

Parameters:

id - The id of the job to delete.

token - The optional authorization token.

Returns:

The response.

statusGet

@Path(value="{id}/status")
 @GET
 @Produces(value="application/json")
public com.google.common.base.Optional<com.spotify.helios.common.descriptors.JobStatus> statusGet(@PathParam(value="id")
                                                                                                                                                                        com.spotify.helios.common.descriptors.JobId id)

Returns the job status for the given job id. The job status includes things like where it's deployed, and the status of the jobs where it's deployed, etc.

Parameters:

id - The job ID.

Returns:

The job status.

jobStatuses

@Path(value="/statuses")
 @POST
 @Produces(value="application/json")
public Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.JobStatus> jobStatuses(Set<com.spotify.helios.common.descriptors.JobId> ids)