com.spotify.helios.master.resources

Class HostsResource

java.lang.Object

com.spotify.helios.master.resources.HostsResource

@Path(value="/hosts")
public class HostsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
HostsResource(MasterModel model)

Method Summary

Modifier and Type	Method and Description
com.spotify.helios.common.protocol.HostDeregisterResponse	delete(String host) Deregisters the host from the cluster.
com.google.common.base.Optional<com.spotify.helios.common.descriptors.HostStatus>	hostStatus(String host, String statusFilter) Returns various status information about the host.
Map<String,com.spotify.helios.common.descriptors.HostStatus>	hostStatuses(List<String> hosts, String statusFilter) Returns various status information about the hosts.
com.spotify.helios.common.protocol.JobUndeployResponse	jobDelete(String host, com.spotify.helios.common.descriptors.JobId jobId, String token) Causes the job identified by its JobId to be undeployed from the specified host.
com.google.common.base.Optional<com.spotify.helios.common.descriptors.Deployment>	jobGet(String host, com.spotify.helios.common.descriptors.JobId jobId) Returns the current Deployment of job on host if it is deployed.
com.spotify.helios.common.protocol.SetGoalResponse	jobPatch(String host, com.spotify.helios.common.descriptors.JobId jobId, com.spotify.helios.common.descriptors.Deployment deployment, String token) Alters the current deployment of a deployed job identified by it's job id on the specified host.
com.spotify.helios.common.protocol.JobDeployResponse	jobPut(String host, com.spotify.helios.common.descriptors.JobId jobId, com.spotify.helios.common.descriptors.Deployment deployment, String username, String token) Sets the deployment of the job identified by its JobId on the host named by host to deployment.
List<String>	list(String namePattern, List<String> hostSelectors) Returns the list of hostnames of known hosts/agents.
javax.ws.rs.core.Response.Status	put(String host, String id) Registers a host with the cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

HostsResource

public HostsResource(MasterModel model)

Method Detail

list

@GET
 @Produces(value="application/json")
public List<String> list(@QueryParam(value="namePattern")
                                                                   String namePattern,
                                                                   @QueryParam(value="selector")
                                                                   List<String> hostSelectors)

Returns the list of hostnames of known hosts/agents.

Returns:

The list of hostnames.

put

@PUT
 @Path(value="{host}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response.Status put(@PathParam(value="host")
                                                                                                             String host,
                                                                                                             @QueryParam(value="id") @DefaultValue(value="")
                                                                                                             String id)

Registers a host with the cluster. The host is the name of the host. It SHOULD be the hostname of the machine. The id should be a persistent value for the host, but initially randomly generated. This way we don't have two machines claiming to be the same host: at least by accident.

Parameters:

host - The host to register.

id - The randomly generated ID for the host.

Returns:

The response.

delete

@DELETE
 @Path(value="{id}")
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.HostDeregisterResponse delete(@PathParam(value="id")
                                                                                                                                          String host)

Deregisters the host from the cluster. Will delete just about everything the cluster knows about it.

Parameters:

host - The host to deregister.

Returns:

The response.

hostStatus

@GET
 @Path(value="{id}/status")
 @Produces(value="application/json")
public com.google.common.base.Optional<com.spotify.helios.common.descriptors.HostStatus> hostStatus(@PathParam(value="id")
                                                                                                                                                                          String host,
                                                                                                                                                                          @QueryParam(value="status") @DefaultValue(value="")
                                                                                                                                                                          String statusFilter)

Returns various status information about the host.

Parameters:

host - The host id.

statusFilter - An optional status filter.

Returns:

The host status.

hostStatuses

@POST
 @Path(value="/statuses")
 @Produces(value="application/json")
public Map<String,com.spotify.helios.common.descriptors.HostStatus> hostStatuses(List<String> hosts,
                                                                                                                                                      @QueryParam(value="status") @DefaultValue(value="")
                                                                                                                                                      String statusFilter)

Returns various status information about the hosts.

Parameters:

hosts - The hosts.

statusFilter - An optional status filter.

Returns:

The response.

jobPut

@PUT
 @Path(value="/{host}/jobs/{job}")
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.JobDeployResponse jobPut(@PathParam(value="host")
                                                                                                                                                String host,
                                                                                                                                                @PathParam(value="job")
                                                                                                                                                com.spotify.helios.common.descriptors.JobId jobId,
                                                                                                                                                com.spotify.helios.common.descriptors.Deployment deployment,
                                                                                                                                                String username,
                                                                                                                                                @QueryParam(value="token") @DefaultValue(value="")
                                                                                                                                                String token)

Sets the deployment of the job identified by its JobId on the host named by host to deployment.

Parameters:

host - The host to deploy to.

jobId - The job to deploy.

deployment - Deployment information.

username - The user deploying.

token - The authorization token for this deployment.

Returns:

The response.

jobDelete

@DELETE
 @Path(value="/{host}/jobs/{job}")
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.JobUndeployResponse jobDelete(@PathParam(value="host")
                                                                                                                                                        String host,
                                                                                                                                                        @PathParam(value="job")
                                                                                                                                                        com.spotify.helios.common.descriptors.JobId jobId,
                                                                                                                                                        @QueryParam(value="token") @DefaultValue(value="")
                                                                                                                                                        String token)

Causes the job identified by its JobId to be undeployed from the specified host. This call will fail if the host is not found or the job is not deployed on the host.

Parameters:

host - The host to undeploy from.

jobId - The job to undeploy.

token - The authorization token.

Returns:

The response.

jobPatch

@Path(value="/{host}/jobs/{job}")
 @Produces(value="application/json")
public com.spotify.helios.common.protocol.SetGoalResponse jobPatch(@PathParam(value="host")
                                                                                                                                          String host,
                                                                                                                                          @PathParam(value="job")
                                                                                                                                          com.spotify.helios.common.descriptors.JobId jobId,
                                                                                                                                          com.spotify.helios.common.descriptors.Deployment deployment,
                                                                                                                                          @QueryParam(value="token") @DefaultValue(value="")
                                                                                                                                          String token)

Alters the current deployment of a deployed job identified by it's job id on the specified host.

Parameters:

host - The host.

jobId - The ID of the job.

deployment - The new deployment.

token - The authorization token for this job.

Returns:

The response.

jobGet

@GET
 @Path(value="/{host}/jobs/{job}")
 @Produces(value="application/json")
public com.google.common.base.Optional<com.spotify.helios.common.descriptors.Deployment> jobGet(@PathParam(value="host")
                                                                                                                                                                             String host,
                                                                                                                                                                             @PathParam(value="job")
                                                                                                                                                                             com.spotify.helios.common.descriptors.JobId jobId)

Returns the current Deployment of job on host if it is deployed.

Parameters:

host - The host where the job is deployed.

jobId - The ID of the job.

Returns:

The response.