Package in.ashwanthkumar.gocd.client

Class GoCD

java.lang.Object

in.ashwanthkumar.gocd.client.GoCD

public class GoCD
extends Object

GoCD Client that's used for accessing some official and un-official APIs.

Note - This is by no means a complete implementation of all the endpoints. Feel free to submit a PR of an endpoint that's missing.

Constructor Summary

Constructors

Constructor	Description
GoCD(HttpClient client)
GoCD(String server, Authentication authenticationMechanism)
GoCD(String server, String username, String password)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
List<String>	allPipelineNames(String pipelinePrefix)
History	pipelineHistory(String pipeline)
History	pipelineHistory(String pipeline, int offset)
Pipeline	pipelineInstance(String pipeline, int pipelineCounter)
Map<Integer,PipelineRunStatus>	pipelineRunStatus(String pipeline)
Map<Integer,PipelineRunStatus>	pipelineRunStatus(String pipelineName, int offset)
PipelineStatus	pipelineStatus(String pipeline)
PluginResources	plugins()	Access all PluginInfo Resources
List<PipelineDependency>	upstreamDependencies(String pipeline, int version)
UserResources	users()	Access all User related resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoCD

public GoCD(HttpClient client)

GoCD

public GoCD(String server,
            Authentication authenticationMechanism)

GoCD

@Deprecated(since="0.0.8",
            forRemoval=true)
public GoCD(String server,
            String username,
            String password)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

allPipelineNames

public List<String> allPipelineNames(String pipelinePrefix)
                              throws IOException

Throws:

IOException

upstreamDependencies

public List<PipelineDependency> upstreamDependencies(String pipeline,
                                                     int version)
                                              throws IOException

Throws:

IOException

pipelineStatus

public PipelineStatus pipelineStatus(String pipeline)
                              throws IOException

Throws:

IOException

pipelineInstance

public Pipeline pipelineInstance(String pipeline,
                                 int pipelineCounter)
                          throws IOException

Throws:

IOException

pipelineHistory

public History pipelineHistory(String pipeline)
                        throws IOException

Throws:

IOException

pipelineHistory

public History pipelineHistory(String pipeline,
                               int offset)
                        throws IOException

Throws:

IOException

pipelineRunStatus

public Map<Integer,PipelineRunStatus> pipelineRunStatus(String pipeline)
                                                       throws IOException

Throws:

IOException

pipelineRunStatus

public Map<Integer,PipelineRunStatus> pipelineRunStatus(String pipelineName,
                                                              int offset)
                                                       throws IOException

Throws:

IOException

users

public UserResources users()

Access all User related resources.

Returns:

UserResources

plugins

public PluginResources plugins()

Access all PluginInfo Resources

Returns:

PluginResources