Package com.octopusdeploy.api

Class ReleasesApi

java.lang.Object

com.octopusdeploy.api.ReleasesApi

public class ReleasesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ReleasesApi(AuthenticatedWebClient webClient)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPortalUrlForLatestRelease(java.lang.String projectId)	Get the partial Octopus portal URL for the latest release of a project
java.lang.String	getPortalUrlForRelease(java.lang.String projectId, java.lang.String releaseVersion)	Get the partial Octopus portal URL for a given release version of a project;
java.util.Set<Release>	getReleasesForProject(java.lang.String projectId)	Get all releases for a given project from the Octopus server;

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleasesApi

public ReleasesApi(AuthenticatedWebClient webClient)

Method Detail

getReleasesForProject

public java.util.Set<Release> getReleasesForProject(java.lang.String projectId)
                                             throws java.lang.IllegalArgumentException,
                                                    java.io.IOException

Get all releases for a given project from the Octopus server;

Parameters:

projectId - the id of the project to get the releases for

Returns:

A set of all releases for a given project

Throws:

java.lang.IllegalArgumentException - when the web client receives a bad parameter

java.io.IOException - When the AuthenticatedWebClient receives and error response code

getPortalUrlForRelease

public java.lang.String getPortalUrlForRelease(java.lang.String projectId,
                                               java.lang.String releaseVersion)
                                        throws java.lang.IllegalArgumentException,
                                               java.io.IOException

Get the partial Octopus portal URL for a given release version of a project;

Parameters:

projectId - the id of the project to get the releases for

releaseVersion - the version of the release to get

Returns:

A version of releases for a given project

Throws:

java.lang.IllegalArgumentException - when the web client receives a bad parameter

java.io.IOException - When the AuthenticatedWebClient receives and error response code

getPortalUrlForLatestRelease

public java.lang.String getPortalUrlForLatestRelease(java.lang.String projectId)
                                              throws java.lang.IllegalArgumentException,
                                                     java.io.IOException

Get the partial Octopus portal URL for the latest release of a project

Parameters:

projectId - the id of the project to get the releases for

Returns:

A version of releases for a given project

Throws:

java.lang.IllegalArgumentException - when the web client receives a bad parameter

java.io.IOException - When the AuthenticatedWebClient receives and error response code