|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBuildAgent
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 |
---|
IBuildServiceHost getServiceHost()
IBuildController getController()
void setController(IBuildController value)
java.lang.String getBuildDirectory()
void setBuildDirectory(java.lang.String value)
java.lang.String getDescription()
void setDescription(java.lang.String value)
AgentStatus getStatus()
void setStatus(AgentStatus value)
boolean isEnabled()
void setEnabled(boolean value)
java.lang.String getStatusMessage()
void setStatusMessage(java.lang.String value)
java.lang.String getURL()
java.lang.String getMessageQueueURL()
java.lang.String[] getTags()
void setTags(java.lang.String[] value)
java.util.Calendar getDateCreated()
java.util.Calendar getDateUpdated()
boolean isReserved()
java.lang.String getReservedForBuild()
java.util.Map<java.lang.String,java.lang.Object> getAttachedProperties()
void delete()
java.lang.String getExpandedBuildDirectory(IBuildDefinition buildDefinition)
buildDefinition
-
void save()
void refresh(java.lang.String[] propertyNameFilters)
propertyNameFilters
- The property names to get.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |