Package com.octopusdeploy.api

Class ChannelsApi

java.lang.Object

com.octopusdeploy.api.ChannelsApi

public class ChannelsApi
extends java.lang.Object

Methods for the Channels aspect of the Octopus API

Constructor Summary

Constructors

Constructor	Description
ChannelsApi(AuthenticatedWebClient webClient)

Method Summary

Modifier and Type	Method	Description
Channel	getChannelByName(java.lang.String projectId, java.lang.String channelName)	Uses the authenticated web client to pull a channel by name from a given project from the api and convert them to POJOs
java.util.Set<Channel>	getChannelsByProjectId(java.lang.String projectId)	Uses the authenticated web client to pull all channels for a given project from the api and convert them to POJOs

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelsApi

public ChannelsApi(AuthenticatedWebClient webClient)

Method Detail

getChannelsByProjectId

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

Uses the authenticated web client to pull all channels for a given project from the api and convert them to POJOs

Parameters:

projectId - the project to get channels for

Returns:

a Set of Channels (should have at minimum one entry)

Throws:

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

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

getChannelByName

public Channel getChannelByName(java.lang.String projectId,
                                java.lang.String channelName)
                         throws java.lang.IllegalArgumentException,
                                java.io.IOException

Uses the authenticated web client to pull a channel by name from a given project from the api and convert them to POJOs

Parameters:

projectId - the project to get channels for

channelName - the channel to return

Returns:

the named channel for the 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