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

声明
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 Build Gets the build in progress associated with this queued build.
Public property BuildAgent Obsolete. Gets the build agent on which this queued build will be built.
Public property BuildAgentUri Obsolete. Gets the URI of the build agent on which this queued build will be built.
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 BuildServer Gets the server that owns this queued build.
Public property CommandLineArguments Obsolete. Gets the command-line arguments used for 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 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 RequestedFor Gets the user for whom the queued 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 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.
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 Save Sends any changes made on the queued build to the server.
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

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace