Share via


IQueuedBuild Interface

The interface for a queued build on the server that is running Team Foundation Build.

Namespace:  Microsoft.TeamFoundation.Build.Client
Assembly:  Microsoft.TeamFoundation.Build.Client (in Microsoft.TeamFoundation.Build.Client.dll)

Syntax

'Declaration
Public Interface IQueuedBuild _
    Inherits IComparable(Of IQueuedBuild)
public interface IQueuedBuild : IComparable<IQueuedBuild>
public interface class IQueuedBuild : IComparable<IQueuedBuild^>
type IQueuedBuild =  
    interface 
        interface IComparable<IQueuedBuild>
    end
public interface IQueuedBuild extends IComparable<IQueuedBuild>

The IQueuedBuild type exposes the following members.

Properties

  Name Description
Public property BatchId The batch ID of the queued build.
Public property Build Gets the build in progress associated with this queued build.
Public property BuildController Gets the build controller on which this queued build will be built.
Public property BuildControllerUri Gets the URI of the build controller on which this queued build will be built.
Public property BuildDefinition Gets the build definition for which this queued build will be built.
Public property BuildDefinitionUri Gets the URI of the build definition for which this queued build will be built.
Public property Builds Gets the collection of builds for this queue entry.
Public property BuildServer Gets the server that owns this queued build.
Public property CustomGetVersion Gets the time for which sources should be retrieved for the queued build.
Public property DropLocation Gets the location where to drop the outputs of the queued build.
Public property GetOption Gets the time for which sources should be retrieved for the queued build.
Public property Id Gets the ID of this queued build.
Public property Priority Gets or sets the priority of this queued build.
Public property ProcessParameters Gets the process parameters that were used for this build.
Public property QueuePosition Gets the current position of the build in the queue.
Public property QueueTime Gets the time when the build was queued.
Public property Reason Gets the reason that the build was queued.
Public property RequestedBy Gets the user who requested the queued build.
Public property RequestedByDisplayName Gets the display name of the user who requested the build.
Public property RequestedFor Gets the user for whom the queued build was requested.
Public property RequestedForDisplayName Gets the display name of the user for whom the build was requested.
Public property ShelvesetName Gets the shelveset that will be built.
Public property Status Gets the status of the queued build.
Public property TeamProject Gets the team project that owns this queued build.

Top

Methods

  Name Description
Public method Cancel Removes this build from the queue.
Public method CompareTo Compares the current object with another object of the same type. (Inherited from IComparable<IQueuedBuild>.)
Public method Connect() Starts polling, by using the default interval of five seconds and no synchronization object. Events will be fired on a thread pool thread. When events are handled by a visual Windows Forms component, the other overload should be used for this method and that component should be passed in as the synchronizingObject so that the event handlers are called on the same thread on which the component was created.
Public method Connect(Int32, Int32, ISynchronizeInvoke) Starts polling, by using the specified interval and ISynchronizeInvoke object. When the StatusChanged, or PollingCompleted events are handled by a visual Windows Forms component, that component should be passed in as the synchronizingObject so that the event handlers are called on the same thread on which the component was created.
Public method Copy Copies the data from the specified queued build into the current instance. The return value indicates whether anything in the queued build was actually updated that would effect state.
Public method Disconnect Stops polling.
Public method Postpone Postpones this queued build.
Public method Refresh Gets the latest property values from the server.
Public method Resume Resumes the queued build.
Public method Retry() Marks the build for retry without batching. If batching with other builds is desired see IBuildServer.RetryQueuedBuilds.
Public method Retry(Guid) Marks the build for retry and puts it in the specified batch.
Public method Retry(Guid, QueuedBuildRetryOption) Marks the build for retry and puts it in the specified batch with the specified retry option.
Public method Save Sends any changes that were made on the queued build to the server.
Public method StartNow Starts the queued build if its definition is currently paused.
Public method Wait Blocks until the queued build is completed.
Public method WaitForBuildCompletion(TimeSpan, TimeSpan) Blocks the calling thread until the build finishes or the time-out expires.
Public method WaitForBuildCompletion(TimeSpan, TimeSpan, ISynchronizeInvoke) Blocks the calling thread until the build finishes or the time-out expires.
Public method WaitForBuildStart() Blocks the build from starting by using the default polling interval of five seconds and an infinite time-out. When this method exits, the Build property will not be null.
Public method WaitForBuildStart(Int32, Int32) Blocks the build from starting by using the specified polling interval and time-out.

Top

Events

  Name Description
Public event PollingCompleted Raised when polling finishes. Note: to receive this event you must call the Connect method. This event is fired when polling finishes, either because the queued build finished or because an unrecoverable error was encountered (e.g. the queued build was deleted).
Public event StatusChanged Raised when any change in the queued build is discovered on the server. Note: to receive these events you must call the Connect method. This causes the server to be polled regularly until the queued build is completed. This event is fired just after the queued build is updated.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace