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

All Superinterfaces:
IBuildGroupItem

public interface IBuildAgent
extends IBuildGroupItem


Method Summary
 void delete()
          Deletes the build agent from the build server.
 java.util.Map<java.lang.String,java.lang.Object> getAttachedProperties()
          Attached properties
 java.lang.String getBuildDirectory()
          The working directory for the build agent.
 IBuildController getController()
          The build controller that owns this build agent.
 java.util.Calendar getDateCreated()
          The date and time at which this agent was created.
 java.util.Calendar getDateUpdated()
          The date and time at which this agent was updated last.
 java.lang.String getDescription()
          The description of the build agent.
 java.lang.String getExpandedBuildDirectory(IBuildDefinition buildDefinition)
          Returns the BuildDirectory for the build agent with all variable expansions evaluated according to the given build definition.
 java.lang.String getMessageQueueURL()
          Gets the message queue address.
 java.lang.String getReservedForBuild()
          Gets the identifier of the build which is currently using this agent or null if not currently in use.
 IBuildServiceHost getServiceHost()
          The service host in which this build agent resides.
 AgentStatus getStatus()
          The status of the build agent - 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 agent's status.
 java.lang.String[] getTags()
          The tags defined for this build agent.
 java.lang.String getURL()
          The URL which may be used to communicate with the build agent.
 boolean isEnabled()
          The Enabled/Disabled flag of the build agent - when not Enabled, the build agent cannot queue or start any new builds.
 boolean isReserved()
          Gets a value indicating whether or not this agent is currently in use by a build.
 void refresh(java.lang.String[] propertyNameFilters)
          Refresh this build agent by getting updated property values from the server.
 void save()
          Saves any changes made to the build agent to the build server.
 void setBuildDirectory(java.lang.String value)
           
 void setController(IBuildController value)
           
 void setDescription(java.lang.String value)
           
 void setEnabled(boolean value)
           
 void setStatus(AgentStatus value)
           
 void setStatusMessage(java.lang.String value)
           
 void setTags(java.lang.String[] value)
           
 
Methods inherited from interface com.microsoft.tfs.core.clients.build.IBuildGroupItem
getFullPath, getName, getTeamProject, getURI, refresh, setName
 

Method Detail

getServiceHost

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

Returns:

getController

IBuildController getController()
The build controller that owns this build agent.

Returns:

setController

void setController(IBuildController value)

getBuildDirectory

java.lang.String getBuildDirectory()
The working directory for the build agent.

Returns:

setBuildDirectory

void setBuildDirectory(java.lang.String value)

getDescription

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

Returns:

setDescription

void setDescription(java.lang.String value)

getStatus

AgentStatus getStatus()
The status of the build agent - 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(AgentStatus value)

isEnabled

boolean isEnabled()
The Enabled/Disabled flag of the build agent - when not Enabled, the build agent 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 agent's status. (May be empty)

Returns:

setStatusMessage

void setStatusMessage(java.lang.String value)

getURL

java.lang.String getURL()
The URL which may be used to communicate with the build agent.

Returns:

getMessageQueueURL

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

Returns:

getTags

java.lang.String[] getTags()
The tags defined for this build agent.

Returns:

setTags

void setTags(java.lang.String[] value)

getDateCreated

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

Returns:

getDateUpdated

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

Returns:

isReserved

boolean isReserved()
Gets a value indicating whether or not this agent is currently in use by a build.

Returns:

getReservedForBuild

java.lang.String getReservedForBuild()
Gets the identifier of the build which is currently using this agent or null if not currently in use.

Returns:

getAttachedProperties

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

Returns:

delete

void delete()
Deletes the build agent from the build server.


getExpandedBuildDirectory

java.lang.String getExpandedBuildDirectory(IBuildDefinition buildDefinition)
Returns the BuildDirectory for the build agent with all variable expansions evaluated according to the given build definition.

Parameters:
buildDefinition -
Returns:

save

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


refresh

void refresh(java.lang.String[] propertyNameFilters)
Refresh this build agent by getting updated property values from the server.

Parameters:
propertyNameFilters - The property names to get.


© 2015 Microsoft. All rights reserved.