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

'Déclaration
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
	Build	Gets the build in progress associated with this queued build.
	BuildAgent	Obsolete. Gets the build agent on which this queued build will be built.
	BuildAgentUri	Obsolete. Gets the URI of the build agent on which this queued build will be built.
	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.
	BuildServer	Gets the server that owns this queued build.
	CommandLineArguments	Obsolete. Gets the command-line arguments used for 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 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.
	RequestedFor	Gets the user for whom the queued 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
	Cancel	Removes this build from the queue.
	CompareTo	Compares the current object with another object of the same type. (Inherited from IComparable<IQueuedBuild>.)
	Copy	Copies the data from the specified 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.
	Postpone	Postpones this queued build.
	Refresh	Gets the latest property values from the server.
	Resume	Resumes the queued build.
	Save	Sends any changes made on the queued build to the server.
	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

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace