BuildRequest Class

Specifies parameters for queuing a build.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Server.BuildRequest

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

Syntax

'Declaration
<CallOnSerializationAttribute("BeforeSerialize")> _
<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)> _
Public NotInheritable Class BuildRequest
[CallOnSerializationAttribute("BeforeSerialize")]
[ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)]
public sealed class BuildRequest
[CallOnSerializationAttribute(L"BeforeSerialize")]
[ClassVisibilityAttribute(ClientVisibility::Internal, ClientVisibility::Internal)]
public ref class BuildRequest sealed
[<Sealed>]
[<CallOnSerializationAttribute("BeforeSerialize")>]
[<ClassVisibilityAttribute(ClientVisibility.Internal, ClientVisibility.Internal)>]
type BuildRequest =  class end
public final class BuildRequest

The BuildRequest type exposes the following members.

Constructors

  Name Description
Public method BuildRequest()
Public method BuildRequest(String, String, String, QueuePriority, String, BuildReason)

Top

Properties

  Name Description
Public property BatchId Gets or sets the batch ID for this request. Requests with matching batch IDs are started together in a single build up to a maximum batch size configured on the Build Definition.
Public property BuildControllerUri Gets or sets the build controller to use for the build. A null value indicates the default build controller of the build definition.
Public property BuildDefinitionUri Gets or sets the target build definition.
Public property CheckInTicket Gets or sets the check-in ticket generated by the server to use for this build.
Public property CustomGetVersion Gets or sets the version of sources to download for the build. Custom must be specified.
Public property DropLocation Gets or sets the drop location to use for the build. A null value indicates the default drop location of the build definition.
Public property GetOption Gets or sets the desired option for determining the version of sources to download for the build.
Public property MaxQueuePosition Gets or sets a value indicating the maximum queue depth enabled for this build.
Public property Postponed Gets or sets a value indicating whether the queued build is active immediately.
Public property Priority Gets or sets the priority of the build.
Public property ProcessParameters Gets or sets the process parameters to use for the build. Parameters that aren't explicitly overridden by the build will inherit values from the build definition.
Public property Reason Gets or sets the reason this build was queued.
Public property RequestedFor Gets or sets the name of the user this build was requested for.
Public property ShelvesetName Gets or sets the name of the shelveset to incorporate in this build.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString (Overrides Object.ToString().)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Server Namespace