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


public interface IBuildDetail


Method Summary
 IBuildDeletionResult delete()
          Deletes the build, and all associated data, from the server and drop location.
 IBuildDeletionResult delete(DeleteOptions options)
          Delete the build and only the associated information you specify.
 IBuildController getBuildController()
          The IBuildController used to perform the build.
 java.lang.String getBuildControllerURI()
          The Uri of the IBuildController used to perform the build.
 IBuildDefinition getBuildDefinition()
          The IBuildDefinition that owns the build.
 java.lang.String getBuildDefinitionURI()
          The Uri of the IBuildDefinition used to perform the build.
 java.lang.String getBuildNumber()
          The Number used to identify the build.
 IBuildServer getBuildServer()
          The server that owns the build.
 com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus getCompilationStatus()
          The status of the compilation phase of the build.
 java.lang.String getDropLocation()
          The location of the output of the build - typically DropLocationRoot\BuildDefinition.Name\BuildNumber.
 java.lang.String getDropLocationRoot()
          The root drop location of the build - either the DefaultDropLocation from its IBuildDefinition, or the overridden DropLocation from its IBuildRequest.
 java.util.Calendar getFinishTime()
          The time that the build finished.
 IBuildInformation getInformation()
          The collection of information nodes for the build.
 java.lang.String getLabelName()
          The name of the label created for the build.
 java.lang.String getLastChangedBy()
          Gets the account name of the last user to change the build.
 java.lang.String getLastChangedByDisplayName()
          Gets the display name of the last user to change the build.
 java.util.Calendar getLastChangedOn()
          The date and time of the last change to the build.
 java.lang.String getLogLocation()
          The location of the log file for the build.
 java.lang.String getProcessParameters()
          The process parameters used for this build.
 java.lang.String getQuality()
          The quality of the build.
 BuildReason getReason()
          The reason the build exists.
 java.lang.String getRequestedBy()
          The user that requested the build.
 java.lang.String getRequestedFor()
          The user for whom the build was requested.
 int[] getRequestIDs()
          The request Ids that started this build.
 IQueuedBuild[] getRequests()
          The requests that started this build.
 java.lang.String getShelvesetName()
          The shelveset that was built.
 java.lang.String getSourceGetVersion()
          The version specification for which the sources were retrieved for the build.
 java.util.Calendar getStartTime()
          The time that the build actually started
 BuildStatus getStatus()
          The overall status of the build.
 java.lang.String getTeamProject()
          Gets the team project that owns the build.
 com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus getTestStatus()
          The status of the test phase of the build.
 java.lang.String getURI()
          The URI of the build.
 boolean isBuildFinished()
          Indicates whether or not the build has finished.
 boolean isIsDeleted()
          The flag that indicates that the build has been deleted
 boolean isKeepForever()
          Specifies whether the build participates in its definition's retention policy or should be kept forever.
 void refresh(java.lang.String[] informationTypes, QueryOptions queryOptions)
          Retrieves the latest build data from the server with the given query options and information types.
 com.microsoft.tfs.util.GUID requestIntermediateLogs()
          Requests the intermediate diagnostics logs of an in-progress build.
 void save()
          Saves any changes made to the build to the server.
 void setBuildNumber(java.lang.String buildNumber)
           
 void setCompilationStatus(com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus compilationStatus)
           
 void setDropLocation(java.lang.String dropLocation)
           
 void setKeepForever(boolean keepForever)
           
 void setLabelName(java.lang.String labelName)
           
 void setLogLocation(java.lang.String logLocation)
           
 void setQuality(java.lang.String buildQuality)
           
 void setStatus(BuildStatus status)
           
 void setTestStatus(com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus testStatus)
           
 void stop()
          Stops the build.
 

Method Detail

getBuildNumber

java.lang.String getBuildNumber()
The Number used to identify the build.

Returns:

setBuildNumber

void setBuildNumber(java.lang.String buildNumber)

getCompilationStatus

com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus getCompilationStatus()
The status of the compilation phase of the build.

Returns:

setCompilationStatus

void setCompilationStatus(com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus compilationStatus)

getDropLocation

java.lang.String getDropLocation()
The location of the output of the build - typically DropLocationRoot\BuildDefinition.Name\BuildNumber.

Returns:

setDropLocation

void setDropLocation(java.lang.String dropLocation)

getDropLocationRoot

java.lang.String getDropLocationRoot()
The root drop location of the build - either the DefaultDropLocation from its IBuildDefinition, or the overridden DropLocation from its IBuildRequest.

Returns:

getLabelName

java.lang.String getLabelName()
The name of the label created for the build.

Returns:

setLabelName

void setLabelName(java.lang.String labelName)

isKeepForever

boolean isKeepForever()
Specifies whether the build participates in its definition's retention policy or should be kept forever.

Returns:

setKeepForever

void setKeepForever(boolean keepForever)

getLogLocation

java.lang.String getLogLocation()
The location of the log file for the build.

Returns:

setLogLocation

void setLogLocation(java.lang.String logLocation)

getQuality

java.lang.String getQuality()
The quality of the build.

Returns:

setQuality

void setQuality(java.lang.String buildQuality)

getStatus

BuildStatus getStatus()
The overall status of the build.

Returns:

setStatus

void setStatus(BuildStatus status)

getTestStatus

com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus getTestStatus()
The status of the test phase of the build.

Returns:

setTestStatus

void setTestStatus(com.microsoft.tfs.core.clients.build.internal.soapextensions.BuildPhaseStatus testStatus)

getBuildController

IBuildController getBuildController()
The IBuildController used to perform the build. (May be null)

Returns:

getBuildControllerURI

java.lang.String getBuildControllerURI()
The Uri of the IBuildController used to perform the build.

Returns:

getBuildDefinition

IBuildDefinition getBuildDefinition()
The IBuildDefinition that owns the build. (May be null)

Returns:

getBuildDefinitionURI

java.lang.String getBuildDefinitionURI()
The Uri of the IBuildDefinition used to perform the build.

Returns:

isBuildFinished

boolean isBuildFinished()
Indicates whether or not the build has finished.

Returns:

getBuildServer

IBuildServer getBuildServer()
The server that owns the build.

Returns:

getInformation

IBuildInformation getInformation()
The collection of information nodes for the build.

Returns:

getLastChangedBy

java.lang.String getLastChangedBy()
Gets the account name of the last user to change the build.

Returns:

getLastChangedByDisplayName

java.lang.String getLastChangedByDisplayName()
Gets the display name of the last user to change the build.

Returns:

getLastChangedOn

java.util.Calendar getLastChangedOn()
The date and time of the last change to the build.

Returns:

getProcessParameters

java.lang.String getProcessParameters()
The process parameters used for this build.

Returns:

getReason

BuildReason getReason()
The reason the build exists.

Returns:

getRequestIDs

int[] getRequestIDs()
The request Ids that started this build.

Returns:

getRequests

IQueuedBuild[] getRequests()
The requests that started this build.

Returns:

isIsDeleted

boolean isIsDeleted()
The flag that indicates that the build has been deleted

Returns:

getSourceGetVersion

java.lang.String getSourceGetVersion()
The version specification for which the sources were retrieved for the build.

Returns:

getStartTime

java.util.Calendar getStartTime()
The time that the build actually started

Returns:

getFinishTime

java.util.Calendar getFinishTime()
The time that the build finished.

Returns:

getURI

java.lang.String getURI()
The URI of the build.

Returns:

getTeamProject

java.lang.String getTeamProject()
Gets the team project that owns the build.

Returns:

delete

IBuildDeletionResult delete()
Deletes the build, and all associated data, from the server and drop location.

Returns:

delete

IBuildDeletionResult delete(DeleteOptions options)
Delete the build and only the associated information you specify.

Parameters:
options - The parts of the build to delete.
Returns:

refresh

void refresh(java.lang.String[] informationTypes,
             QueryOptions queryOptions)
Retrieves the latest build data from the server with the given query options and information types.

Parameters:
informationTypes - The information types which should be retrieved. Valid types include "*", meaning all types, and the members of Microsoft.TeamFoundation.Build.Common.InformationTypes.
queryOptions - The query options to use for the Refresh.

save

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


stop

void stop()
Stops the build.


requestIntermediateLogs

com.microsoft.tfs.util.GUID requestIntermediateLogs()
Requests the intermediate diagnostics logs of an in-progress build.

Returns:
The request identifier

getRequestedBy

java.lang.String getRequestedBy()
The user that requested the build.

Returns:

getRequestedFor

java.lang.String getRequestedFor()
The user for whom the build was requested.

Returns:

getShelvesetName

java.lang.String getShelvesetName()
The shelveset that was built.

Returns:


© 2015 Microsoft. All rights reserved.