Package com.octopusdeploy.api

Class DeploymentsApi

java.lang.Object

com.octopusdeploy.api.DeploymentsApi

public class DeploymentsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
DeploymentsApi(AuthenticatedWebClient webClient)

Method Summary

Modifier and Type	Method	Description
DeploymentProcess	getDeploymentProcessForProject(java.lang.String projectId)	Return a representation of a deployment process for a given project.
DeploymentProcessTemplate	getDeploymentProcessTemplateForProject(java.lang.String projectId)	Return a representation of a deployment process for a given project.
java.lang.String	getPortalUrlForDeployment(java.lang.String projectId, java.lang.String releaseVersion, java.lang.String environmentId, java.lang.String tenantId)	Get the url for a deployment given the following params;

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentsApi

public DeploymentsApi(AuthenticatedWebClient webClient)

Method Detail

getPortalUrlForDeployment

public java.lang.String getPortalUrlForDeployment(java.lang.String projectId,
                                                  java.lang.String releaseVersion,
                                                  java.lang.String environmentId,
                                                  java.lang.String tenantId)
                                           throws java.lang.IllegalArgumentException,
                                                  java.io.IOException

Get the url for a deployment given the following params;

Parameters:

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

releaseVersion - the version of the release to get

environmentId - the id of the environment

tenantId - the id of the tenant

Returns:

A partial url to the Octopus portal to view the deployment

Throws:

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

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

getDeploymentProcessForProject

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

Return a representation of a deployment process for a given project.

Parameters:

projectId - the id of the project to get the process for.

Returns:

DeploymentProcess a representation of the process

Throws:

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

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

getDeploymentProcessTemplateForProject

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

Return a representation of a deployment process for a given project.

Parameters:

projectId - project id

Returns:

DeploymentProcessTemplate deployment process template

Throws:

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

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