IBuildRequest Interface

Interface for a build request 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 IBuildRequest
public interface IBuildRequest
public interface class IBuildRequest
type IBuildRequest =  interface end
public interface IBuildRequest

The IBuildRequest type exposes the following members.

Properties

Name Description
Public property BatchId The batch ID for the request.
Public property BuildController Gets or sets the build controller that will start the requested build.
Public property BuildControllerUri Gets the uniform resource identifier (URI) of the build controller that will start the requested build.
Public property BuildDefinition Gets the build definition for which the requested build should be started. Provides default values for BuildController and DropLocation.
Public property BuildDefinitionUri Gets the URI of the build definition for which the requested build should be started.
Public property BuildServer Gets the build server from which this build request was created.
Public property CustomGetVersion Gets or sets the custom get versionSpec. Valid only when GetOption is set to 'Custom'.
Public property DropLocation Gets or sets the location in which to drop the output of the requested build.
Public property GatedCheckInTicket Gets or sets an optional ticket that is issued by the server for gated check-in submissions.
Public property GetOption Gets or sets the time for which sources should be retrieved for the requested build. Valid settings are 'LatestOnQueue', 'LatestOnBuild', or 'Custom'.
Public property MaxQueuePosition Gets or sets the maximum position in the queue for the requested build at queue time. If the build request falls below this position in the queue, an exception will be thrown.
Public property Postponed Gets or sets a flag that describes whether the build request will be submitted together with a postponed status.
Public property Priority Gets or sets the priority for the requested build.
Public property ProcessParameters Gets an XML formatted string representing all the process parameters for this build.
Public property Reason Gets or sets the reason for the build request.
Public property RequestedFor Gets or sets the user for whom the build is being requested.
Public property ShelvesetName Gets or sets an optional shelveset to be built.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace