com.spotify.helios.client

Class HeliosClient

java.lang.Object

com.spotify.helios.client.HeliosClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class HeliosClient
extends Object
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeliosClient.Builder

Constructor Summary

Constructors

Constructor and Description
HeliosClient(String user, com.spotify.helios.client.RequestDispatcher dispatcher)

Method Summary

Modifier and Type	Method and Description
void	close()
static HeliosClient	create(String domain, String user) Create a new helios client as a specific user, connecting to a helios master cluster in a specific domain.
com.google.common.util.concurrent.ListenableFuture<CreateDeploymentGroupResponse>	createDeploymentGroup(DeploymentGroup descriptor)
com.google.common.util.concurrent.ListenableFuture<CreateJobResponse>	createJob(Job descriptor)
com.google.common.util.concurrent.ListenableFuture<JobDeleteResponse>	deleteJob(JobId id)
com.google.common.util.concurrent.ListenableFuture<JobDeleteResponse>	deleteJob(JobId id, String token)
com.google.common.util.concurrent.ListenableFuture<JobDeployResponse>	deploy(Deployment job, String host)
com.google.common.util.concurrent.ListenableFuture<JobDeployResponse>	deploy(Deployment job, String host, String token)
com.google.common.util.concurrent.ListenableFuture<Deployment>	deployment(String host, JobId job)
com.google.common.util.concurrent.ListenableFuture<DeploymentGroup>	deploymentGroup(String name)
com.google.common.util.concurrent.ListenableFuture<DeploymentGroupStatusResponse>	deploymentGroupStatus(String name)
com.google.common.util.concurrent.ListenableFuture<HostDeregisterResponse>	deregisterHost(String host)
com.google.common.util.concurrent.ListenableFuture<HostStatus>	hostStatus(String host)
com.google.common.util.concurrent.ListenableFuture<HostStatus>	hostStatus(String host, Map<String,String> queryParams)
com.google.common.util.concurrent.ListenableFuture<Map<String,HostStatus>>	hostStatuses(List<String> hosts)
com.google.common.util.concurrent.ListenableFuture<Map<String,HostStatus>>	hostStatuses(List<String> hosts, Map<String,String> queryParams)
com.google.common.util.concurrent.ListenableFuture<TaskStatusEvents>	jobHistory(JobId jobId)
com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>>	jobs() Lists all jobs that exist in the Helios cluster.
com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>>	jobs(String jobQuery) Lists all jobs in the cluster whose name starts with the given string.
com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>>	jobs(String jobQuery, String hostNamePattern) Lists all jobs in the cluster whose name starts with the given string, and that are deployed to hosts that match the given name pattern.
com.google.common.util.concurrent.ListenableFuture<JobStatus>	jobStatus(JobId jobId)
com.google.common.util.concurrent.ListenableFuture<Map<JobId,JobStatus>>	jobStatuses(Set<JobId> jobs)
com.google.common.util.concurrent.ListenableFuture<List<String>>	listDeploymentGroups()
com.google.common.util.concurrent.ListenableFuture<List<String>>	listHosts() Returns a list of all hosts registered in the Helios cluster.
com.google.common.util.concurrent.ListenableFuture<List<String>>	listHosts(Set<String> unparsedHostSelectors) Returns a list of all hosts registered in the Helios cluster which match the given list of host selectors.
com.google.common.util.concurrent.ListenableFuture<List<String>>	listHosts(String namePattern) Returns a list of all hosts registered in the Helios cluster whose name matches the given pattern.
com.google.common.util.concurrent.ListenableFuture<List<String>>	listHosts(String namePattern, Set<String> unparsedHostSelectors) Returns a list of all hosts registered in the Helios cluster that match both the given hostname pattern and set of host selectors.
com.google.common.util.concurrent.ListenableFuture<List<String>>	listMasters()
static HeliosClient.Builder	newBuilder()
com.google.common.util.concurrent.ListenableFuture<Integer>	registerHost(String host, String id)
com.google.common.util.concurrent.ListenableFuture<RemoveDeploymentGroupResponse>	removeDeploymentGroup(String name)
com.google.common.util.concurrent.ListenableFuture<RollingUpdateResponse>	rollingUpdate(String deploymentGroupName, JobId job, RolloutOptions options)
com.google.common.util.concurrent.ListenableFuture<SetGoalResponse>	setGoal(Deployment job, String host)
com.google.common.util.concurrent.ListenableFuture<SetGoalResponse>	setGoal(Deployment job, String host, String token)
com.google.common.util.concurrent.ListenableFuture<Integer>	stopDeploymentGroup(String deploymentGroupName)
com.google.common.util.concurrent.ListenableFuture<JobUndeployResponse>	undeploy(JobId jobId, String host)
com.google.common.util.concurrent.ListenableFuture<JobUndeployResponse>	undeploy(JobId jobId, String host, String token)
com.google.common.util.concurrent.ListenableFuture<VersionResponse>	version()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeliosClient

public HeliosClient(String user,
                    com.spotify.helios.client.RequestDispatcher dispatcher)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

deploy

public com.google.common.util.concurrent.ListenableFuture<JobDeployResponse> deploy(Deployment job,
                                                                                    String host)

deploy

public com.google.common.util.concurrent.ListenableFuture<JobDeployResponse> deploy(Deployment job,
                                                                                    String host,
                                                                                    String token)

setGoal

public com.google.common.util.concurrent.ListenableFuture<SetGoalResponse> setGoal(Deployment job,
                                                                                   String host)

setGoal

public com.google.common.util.concurrent.ListenableFuture<SetGoalResponse> setGoal(Deployment job,
                                                                                   String host,
                                                                                   String token)

deployment

public com.google.common.util.concurrent.ListenableFuture<Deployment> deployment(String host,
                                                                                 JobId job)

hostStatus

public com.google.common.util.concurrent.ListenableFuture<HostStatus> hostStatus(String host)

hostStatus

public com.google.common.util.concurrent.ListenableFuture<HostStatus> hostStatus(String host,
                                                                                 Map<String,String> queryParams)

hostStatuses

public com.google.common.util.concurrent.ListenableFuture<Map<String,HostStatus>> hostStatuses(List<String> hosts)

hostStatuses

public com.google.common.util.concurrent.ListenableFuture<Map<String,HostStatus>> hostStatuses(List<String> hosts,
                                                                                               Map<String,String> queryParams)

registerHost

public com.google.common.util.concurrent.ListenableFuture<Integer> registerHost(String host,
                                                                                String id)

deleteJob

public com.google.common.util.concurrent.ListenableFuture<JobDeleteResponse> deleteJob(JobId id)

deleteJob

public com.google.common.util.concurrent.ListenableFuture<JobDeleteResponse> deleteJob(JobId id,
                                                                                       String token)

undeploy

public com.google.common.util.concurrent.ListenableFuture<JobUndeployResponse> undeploy(JobId jobId,
                                                                                        String host)

undeploy

public com.google.common.util.concurrent.ListenableFuture<JobUndeployResponse> undeploy(JobId jobId,
                                                                                        String host,
                                                                                        String token)

deregisterHost

public com.google.common.util.concurrent.ListenableFuture<HostDeregisterResponse> deregisterHost(String host)

listHosts

public com.google.common.util.concurrent.ListenableFuture<List<String>> listHosts()

Returns a list of all hosts registered in the Helios cluster.

listHosts

public com.google.common.util.concurrent.ListenableFuture<List<String>> listHosts(String namePattern)

Returns a list of all hosts registered in the Helios cluster whose name matches the given pattern.

listHosts

public com.google.common.util.concurrent.ListenableFuture<List<String>> listHosts(Set<String> unparsedHostSelectors)

Returns a list of all hosts registered in the Helios cluster which match the given list of host selectors.

For example, listHosts(Arrays.asList("site=foo")) will return all agents in the cluster whose labels match the expression site=foo.

listHosts

public com.google.common.util.concurrent.ListenableFuture<List<String>> listHosts(String namePattern,
                                                                                  Set<String> unparsedHostSelectors)

Returns a list of all hosts registered in the Helios cluster that match both the given hostname pattern and set of host selectors.

See Also:

listHosts(Set)

listMasters

public com.google.common.util.concurrent.ListenableFuture<List<String>> listMasters()

version

public com.google.common.util.concurrent.ListenableFuture<VersionResponse> version()

createJob

public com.google.common.util.concurrent.ListenableFuture<CreateJobResponse> createJob(Job descriptor)

jobs

public com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>> jobs()

Lists all jobs that exist in the Helios cluster.

jobs

public com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>> jobs(@Nullable
                                                                               String jobQuery)

Lists all jobs in the cluster whose name starts with the given string.

Parameters:

jobQuery - job name filter

jobs

public com.google.common.util.concurrent.ListenableFuture<Map<JobId,Job>> jobs(@Nullable
                                                                               String jobQuery,
                                                                               @Nullable
                                                                               String hostNamePattern)

Lists all jobs in the cluster whose name starts with the given string, and that are deployed to hosts that match the given name pattern.

Parameters:

jobQuery - job name filter

hostNamePattern - hostname filter

jobHistory

public com.google.common.util.concurrent.ListenableFuture<TaskStatusEvents> jobHistory(JobId jobId)

jobStatus

public com.google.common.util.concurrent.ListenableFuture<JobStatus> jobStatus(JobId jobId)

jobStatuses

public com.google.common.util.concurrent.ListenableFuture<Map<JobId,JobStatus>> jobStatuses(Set<JobId> jobs)

deploymentGroup

public com.google.common.util.concurrent.ListenableFuture<DeploymentGroup> deploymentGroup(String name)

listDeploymentGroups

public com.google.common.util.concurrent.ListenableFuture<List<String>> listDeploymentGroups()

deploymentGroupStatus

public com.google.common.util.concurrent.ListenableFuture<DeploymentGroupStatusResponse> deploymentGroupStatus(String name)

createDeploymentGroup

public com.google.common.util.concurrent.ListenableFuture<CreateDeploymentGroupResponse> createDeploymentGroup(DeploymentGroup descriptor)

removeDeploymentGroup

public com.google.common.util.concurrent.ListenableFuture<RemoveDeploymentGroupResponse> removeDeploymentGroup(String name)

rollingUpdate

public com.google.common.util.concurrent.ListenableFuture<RollingUpdateResponse> rollingUpdate(String deploymentGroupName,
                                                                                               JobId job,
                                                                                               RolloutOptions options)

stopDeploymentGroup

public com.google.common.util.concurrent.ListenableFuture<Integer> stopDeploymentGroup(String deploymentGroupName)

newBuilder

public static HeliosClient.Builder newBuilder()

create

public static HeliosClient create(String domain,
                                  String user)

Create a new helios client as a specific user, connecting to a helios master cluster in a specific domain.

Parameters:

domain - The target domain.

user - The user to identify as.

Returns:

A helios client.