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 | |
|---|---|---|
.gif "Public property") |
BatchId | The batch ID of the queued build. |
|
Build | Gets the build in progress associated with this queued build. |
|
BuildController | Gets the build controller on which this queued build will be built. |
|
BuildControllerUri | Gets the URI of the build controller on which this queued build will be built. |
|
BuildDefinition | Gets the build definition for which this queued build will be built. |
|
BuildDefinitionUri | Gets the URI of the build definition for which this queued build will be built. |
|
Builds | Gets the collection of builds for this queue entry. |
|
BuildServer | Gets the server that owns this queued build. |
|
CustomGetVersion | Gets the time for which sources should be retrieved for the queued build. |
|
DropLocation | Gets the location where to drop the outputs of the queued build. |
|
GetOption | Gets the time for which sources should be retrieved for the queued build. |
|
Id | Gets the ID of this queued build. |
|
Priority | Gets or sets the priority of this queued build. |
|
ProcessParameters | Gets the process parameters that were used for this build. |
|
QueuePosition | Gets the current position of the build in the queue. |
|
QueueTime | Gets the time when the build was queued. |
|
Reason | Gets the reason that the build was queued. |
|
RequestedBy | Gets the user who requested the queued build. |
|
RequestedByDisplayName | Gets the display name of the user who requested the build. |
|
RequestedFor | Gets the user for whom the queued build was requested. |
|
RequestedForDisplayName | Gets the display name of the user for whom the build was requested. |
|
ShelvesetName | Gets the shelveset that will be built. |
|
Status | Gets the status of the queued build. |
|
TeamProject | Gets the team project that owns this queued build. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Cancel | Removes this build from the queue. |
|
CompareTo | Compares the current object with another object of the same type. (Inherited from IComparable<IQueuedBuild>.) |
|
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. |
|
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. |
|
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. |
|
Disconnect | Stops polling. |
|
Postpone | Postpones this queued build. |
|
Refresh | Gets the latest property values from the server. |
|
Resume | Resumes the queued build. |
|
Retry() | Marks the build for retry without batching. If batching with other builds is desired see IBuildServer.RetryQueuedBuilds. |
|
Retry(Guid) | Marks the build for retry and puts it in the specified batch. |
|
Retry(Guid, QueuedBuildRetryOption) | Marks the build for retry and puts it in the specified batch with the specified retry option. |
|
Save | Sends any changes that were made on the queued build to the server. |
|
StartNow | Starts the queued build if its definition is currently paused. |
|
Wait | Blocks until the queued build is completed. |
|
WaitForBuildCompletion(TimeSpan, TimeSpan) | Blocks the calling thread until the build finishes or the time-out expires. |
|
WaitForBuildCompletion(TimeSpan, TimeSpan, ISynchronizeInvoke) | Blocks the calling thread until the build finishes or the time-out expires. |
|
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. |
|
WaitForBuildStart(Int32, Int32) | Blocks the build from starting by using the specified polling interval and time-out. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "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). |
|
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