com.microsoft.tfs.core.clients.build
Interface IBuildController


public interface IBuildController


Method Summary
 void addBuildAgent(IBuildAgent agent)
          Adds a build agent to this controller.
 void delete()
          Deletes the build controller.
 IBuildAgent[] getAgents()
          The build agents owned by this controller.
 java.util.Map<java.lang.String,java.lang.Object> getAttachedProperties()
          Attached properties
 java.lang.String getCustomAssemblyPath()
          The version control path where custom assemblies are stored.
 java.util.Calendar getDateCreated()
          The date and time at which this controller was created.
 java.util.Calendar getDateUpdated()
          The date and time at which this controller was updated last.
 java.lang.String getDescription()
          The description of the build controller.
 int getMaxConcurrentBuilds()
          The maximum number of builds that may run concurrently on this controller.
 java.lang.String getMessageQueueURL()
          Gets the message queue address.
 java.lang.String getName()
          The name of the build controller.
 int getQueueCount()
          The current queue count (all queue statuses included) for the controller.
 IBuildServiceHost getServiceHost()
          The service host in which this controller resides.
 ControllerStatus getStatus()
          The status of the build controller - when Offline it will not be reached by AT, when Unavailable AT will attempt to fix, when Available it's working.
 java.lang.String getStatusMessage()
          A displayable message from the server regarding the controller's status.
 java.lang.String[] getTags()
          The union of the tags for all the controller's agents.
 java.lang.String getURI()
          The Uri of the build controller.
 java.lang.String getURL()
          The URL of the build controller.
 boolean isEnabled()
          The Enabled/Disabled flag of the build controller - when not Enabled, the build controller cannot queue or start any new builds.
 void refresh(boolean refreshAgentList)
          Refreshes the build controller by getting current property values from the build server.
 void refresh(java.lang.String[] propertyNameFilters, boolean refreshAgentList)
          Refreshes the build controller by getting current property values from the build server.
 void removeBuildAgent(IBuildAgent agent)
          Removes a build agent from this controller.
 void save()
          Saves any changes made to the build controller to the build server.
 void setCustomAssemblyPath(java.lang.String value)
           
 void setDescription(java.lang.String value)
           
 void setEnabled(boolean value)
           
 void setMaxConcurrentBuilds(int value)
           
 void setName(java.lang.String value)
           
 void setStatus(ControllerStatus value)
           
 void setStatusMessage(java.lang.String value)
           
 

Method Detail

getServiceHost

IBuildServiceHost getServiceHost()
The service host in which this controller resides.

Returns:

getAgents

IBuildAgent[] getAgents()
The build agents owned by this controller.

Returns:

getCustomAssemblyPath

java.lang.String getCustomAssemblyPath()
The version control path where custom assemblies are stored.

Returns:

setCustomAssemblyPath

void setCustomAssemblyPath(java.lang.String value)

getDescription

java.lang.String getDescription()
The description of the build controller.

Returns:

setDescription

void setDescription(java.lang.String value)

getName

java.lang.String getName()
The name of the build controller.

Returns:

setName

void setName(java.lang.String value)

getMaxConcurrentBuilds

int getMaxConcurrentBuilds()
The maximum number of builds that may run concurrently on this controller.

Returns:

setMaxConcurrentBuilds

void setMaxConcurrentBuilds(int value)

getQueueCount

int getQueueCount()
The current queue count (all queue statuses included) for the controller.

Returns:

getStatus

ControllerStatus getStatus()
The status of the build controller - when Offline it will not be reached by AT, when Unavailable AT will attempt to fix, when Available it's working.

Returns:

setStatus

void setStatus(ControllerStatus value)

isEnabled

boolean isEnabled()
The Enabled/Disabled flag of the build controller - when not Enabled, the build controller cannot queue or start any new builds.

Returns:

setEnabled

void setEnabled(boolean value)

getStatusMessage

java.lang.String getStatusMessage()
A displayable message from the server regarding the controller's status. (May be empty)

Returns:

setStatusMessage

void setStatusMessage(java.lang.String value)

getAttachedProperties

java.util.Map<java.lang.String,java.lang.Object> getAttachedProperties()
Attached properties

Returns:

getTags

java.lang.String[] getTags()
The union of the tags for all the controller's agents.

Returns:

getURI

java.lang.String getURI()
The Uri of the build controller.

Returns:

getURL

java.lang.String getURL()
The URL of the build controller.

Returns:

getMessageQueueURL

java.lang.String getMessageQueueURL()
Gets the message queue address. This field is for system use only.

Returns:

getDateCreated

java.util.Calendar getDateCreated()
The date and time at which this controller was created.

Returns:

getDateUpdated

java.util.Calendar getDateUpdated()
The date and time at which this controller was updated last.

Returns:

addBuildAgent

void addBuildAgent(IBuildAgent agent)
Adds a build agent to this controller.

Parameters:
agent - The agent to be added.

delete

void delete()
Deletes the build controller.


refresh

void refresh(boolean refreshAgentList)
Refreshes the build controller by getting current property values from the build server.

Parameters:
refreshAgentList - If true, agents are requested from the server and the list of agents is replaced

refresh

void refresh(java.lang.String[] propertyNameFilters,
             boolean refreshAgentList)
Refreshes the build controller by getting current property values from the build server.

Parameters:
propertyNameFilters - The property names to get.
refreshAgentList - If true, agents are requested from the server and the list of agents is replaced.

removeBuildAgent

void removeBuildAgent(IBuildAgent agent)
Removes a build agent from this controller.

Parameters:
agent - The agent to be removed.

save

void save()
Saves any changes made to the build controller to the build server.



© 2015 Microsoft. All rights reserved.