BuildRequest Class

Article
07/02/2014

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
	BuildRequest()
	BuildRequest(String, String, String, QueuePriority, String, BuildReason)

Top

Properties

	Name	Description
	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.
	BuildControllerUri	Gets or sets the build controller to use for the build. A null value indicates the default build controller of the build definition.
	BuildDefinitionUri	Gets or sets the target build definition.
	CheckInTicket	Gets or sets the check-in ticket generated by the server to use for this build.
	CustomGetVersion	Gets or sets the version of sources to download for the build. Custom must be specified.
	DropLocation	Gets or sets the drop location to use for the build. A null value indicates the default drop location of the build definition.
	GetOption	Gets or sets the desired option for determining the version of sources to download for the build.
	MaxQueuePosition	Gets or sets a value indicating the maximum queue depth enabled for this build.
	Postponed	Gets or sets a value indicating whether the queued build is active immediately.
	Priority	Gets or sets the priority of the build.
	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.
	Reason	Gets or sets the reason this build was queued.
	RequestedFor	Gets or sets the name of the user this build was requested for.
	ShelvesetName	Gets or sets the name of the shelveset to incorporate in this build.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.

Partager via