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

All Superinterfaces:
java.lang.Comparable<IQueuedBuild>

public interface IQueuedBuild
extends java.lang.Comparable<IQueuedBuild>


Method Summary
 void cancel()
          Removes the build from the queue.
 boolean copy(IQueuedBuild build, QueryOptions options)
          Copies the data from the queued build into the current instance.
 com.microsoft.tfs.util.GUID getBatchID()
          The batch ID of the queued build.
 IBuildDetail getBuild()
          Gets the currently active build.
 IBuildController getBuildController()
          The build controller on which the queued build will be built.
 java.lang.String getBuildControllerURI()
          The URI of the build controller on which the queued build will be built.
 IBuildDefinition getBuildDefinition()
          The build definition for which the queued build will be built.
 java.lang.String getBuildDefinitionURI()
          The URI of the build definition for which the queued build will be built.
 java.util.List<IBuildDetail> getBuilds()
          Gets the collection of builds for this queue entry.
 IBuildServer getBuildServer()
          The server that owns this queued build.
 java.lang.String getCustomGetVersion()
          If GetOption is CustomTime, the time for which sources should be retrieved for the queued build.
 java.lang.String getDropLocation()
          The location at which to drop the outputs of the queued build.
 GetOption getGetOption()
          The time for which sources should be retrieved for the queued build - either QueueTime, BuildTime, or CustomTime.
 int getID()
          The unique Id of the queued build.
 QueuePriority getPriority()
          The priority of the queued build.
 java.lang.String getProcessParameters()
          The process parameters used for this build.
 int getQueuePosition()
          The current position of the build in the queue.
 java.util.Calendar getQueueTime()
          The time at which the build was queued.
 BuildReason getReason()
          The reason that the build was queued.
 java.lang.String getRequestedBy()
          Gets the account name of the user who requested the build.
 java.lang.String getRequestedByDisplayName()
          Gets the display name of the user who requested the build.
 java.lang.String getRequestedFor()
          Gets the account name of the user for whom the build was requested.
 java.lang.String getRequestedForDisplayName()
          Gets the display name of the user for whom the build was requested.
 java.lang.String getShelvesetName()
          The shelveset that will be built.
 QueueStatus getStatus()
          The status of the queued build.
 java.lang.String getTeamProject()
          Gets the team project that owns the queued build.
 void postpone()
          Postpones the queued build.
 void refresh(QueryOptions queryOptions)
          Retrieves the latest property values from the server.
 void resume()
          Resumes the queued build.
 void retry()
          Marks the build for retry without batching.
 void retry(com.microsoft.tfs.util.GUID batchId)
          Marks the build for retry and places it in the specified batch.
 void retry(com.microsoft.tfs.util.GUID batchId, QueuedBuildRetryOption retryOption)
          Marks the build for retry and places it in the specified batch with the specified retry option.
 void save()
          Sends any changes made to the queued build to the server.
 void setPriority(QueuePriority value)
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getPriority

QueuePriority getPriority()
The priority of the queued build.

Returns:

setPriority

void setPriority(QueuePriority value)

getBatchID

com.microsoft.tfs.util.GUID getBatchID()
The batch ID of the queued build.

Returns:

getID

int getID()
The unique Id of the queued build.

Returns:

getTeamProject

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

Returns:

getBuildController

IBuildController getBuildController()
The build controller on which the queued build will be built.

Returns:

getBuildControllerURI

java.lang.String getBuildControllerURI()
The URI of the build controller on which the queued build will be built.

Returns:

getBuildDefinition

IBuildDefinition getBuildDefinition()
The build definition for which the queued build will be built.

Returns:

getBuildDefinitionURI

java.lang.String getBuildDefinitionURI()
The URI of the build definition for which the queued build will be built.

Returns:

getBuilds

java.util.List<IBuildDetail> getBuilds()
Gets the collection of builds for this queue entry.

Returns:

getBuild

IBuildDetail getBuild()
Gets the currently active build.

Returns:

getBuildServer

IBuildServer getBuildServer()
The server that owns this queued build.

Returns:

getCustomGetVersion

java.lang.String getCustomGetVersion()
If GetOption is CustomTime, the time for which sources should be retrieved for the queued build.

Returns:

getDropLocation

java.lang.String getDropLocation()
The location at which to drop the outputs of the queued build.

Returns:

getGetOption

GetOption getGetOption()
The time for which sources should be retrieved for the queued build - either QueueTime, BuildTime, or CustomTime.

Returns:

getQueueTime

java.util.Calendar getQueueTime()
The time at which the build was queued.

Returns:

getProcessParameters

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

Returns:

getQueuePosition

int getQueuePosition()
The current position of the build in the queue.

Returns:

getReason

BuildReason getReason()
The reason that the build was queued.

Returns:

getRequestedBy

java.lang.String getRequestedBy()
Gets the account name of the user who requested the build.

Returns:

getRequestedByDisplayName

java.lang.String getRequestedByDisplayName()
Gets the display name of the user who requested the build.

Returns:

getRequestedFor

java.lang.String getRequestedFor()
Gets the account name of the user for whom the build was requested.

Returns:

getRequestedForDisplayName

java.lang.String getRequestedForDisplayName()
Gets the display name of the user for whom the build was requested.

Returns:

getShelvesetName

java.lang.String getShelvesetName()
The shelveset that will be built.

Returns:

getStatus

QueueStatus getStatus()
The status of the queued build.

Returns:

cancel

void cancel()
Removes the build from the queue.


copy

boolean copy(IQueuedBuild build,
             QueryOptions options)
Copies the data from the queued build into the current instance. The return value indicates whether or not anything in the queued build was actually updated that would effect state.

Parameters:
build - The source of the copy operation
options - The options used to query the copy source
Returns:
True if the build state changed, false otherwise

postpone

void postpone()
Postpones the queued build.


refresh

void refresh(QueryOptions queryOptions)
Retrieves the latest property values from the server.

Parameters:
queryOptions -

resume

void resume()
Resumes the queued build.


retry

void retry()
Marks the build for retry without batching. If batching with other builds is desired see IBuildServer.RetryQueuedBuilds.


retry

void retry(com.microsoft.tfs.util.GUID batchId)
Marks the build for retry and places it in the specified batch.

Parameters:
batchId - The batch in which this build should be included

retry

void retry(com.microsoft.tfs.util.GUID batchId,
           QueuedBuildRetryOption retryOption)
Marks the build for retry and places it in the specified batch with the specified retry option.

Parameters:
batchId - The batch in which this build should be included
retryOption - Option to retry a completed or an in progress build

save

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



© 2015 Microsoft. All rights reserved.