Package com.octopusdeploy.api

Class VariablesApi

java.lang.Object

com.octopusdeploy.api.VariablesApi

public class VariablesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
VariablesApi(AuthenticatedWebClient webClient)

Method Summary

Modifier and Type	Method	Description
java.util.Set<Variable>	getVariablesByReleaseAndEnvironment(java.lang.String releaseId, java.lang.String environmentId, java.util.Properties entryProperties)	Get the variables for a combination of release and environment, return null otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablesApi

public VariablesApi(AuthenticatedWebClient webClient)

Method Detail

getVariablesByReleaseAndEnvironment

public java.util.Set<Variable> getVariablesByReleaseAndEnvironment(java.lang.String releaseId,
                                                                   java.lang.String environmentId,
                                                                   java.util.Properties entryProperties)
                                                            throws java.lang.IllegalArgumentException,
                                                                   java.io.IOException

Get the variables for a combination of release and environment, return null otherwise.

Parameters:

releaseId - The id of the Release.

environmentId - The id of the Environment.

entryProperties - entry properties

Returns:

A set of all variables for a given Release and Environment combination.

Throws:

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

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