IBuildDefinition Interface

This interface represents a build definition.

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

Syntax

'Declaration
Public Interface IBuildDefinition _
    Inherits IBuildGroupItem
public interface IBuildDefinition : IBuildGroupItem
public interface class IBuildDefinition : IBuildGroupItem
type IBuildDefinition =  
    interface 
        interface IBuildGroupItem 
    end
public interface IBuildDefinition extends IBuildGroupItem

The IBuildDefinition type exposes the following members.

Properties

Name Description
Public property AttachedProperties Attached properties
Public property BatchSize The maximum batch size for queued builds when you use the Gated continuous integration type.
Public property BuildController Gets or sets the build controller that builds this build definition.
Public property BuildControllerUri Gets the uniform resource identifier (URI) of the build controller that builds this build definition.
Public property BuildServer Gets the server or computer that is hosting the build definition.
Public property ContinuousIntegrationQuietPeriod Gets or sets the time (in minutes) of the quiet period that is associated with Batch type continuous integration builds.
Public property ContinuousIntegrationType Gets or sets the continuous integration type of the build definition.
Public property DateCreated The date and time at which this build definition was created.
Public property DefaultDropLocation Gets or sets the default drop location for builds generated by the build definition.
Public property Description Gets or sets the description for the build definition.
Public property Enabled Obsolete. Gets or sets the enabled status of the build definition.
Public property FullPath Gets the full path of this build group item. (Inherited from IBuildGroupItem.)
Public property Id Gets the ID of this build definition.
Public property LastBuildUri Gets the URI of the last build for the build definition, regardless of status.
Public property LastGoodBuildLabel Gets the name of the label for the last successful build for the build definition.
Public property LastGoodBuildUri Gets the URI for the last successful build for the build definition.
Public property Name Gets or sets the name of this build group item. (Inherited from IBuildGroupItem.)
Public property Process Gets or sets the build process template for this definition.
Public property ProcessParameters Gets an XML formatted string representing all the process parameters for this build.
Public property QueueStatus The queue status of the build definition.
Public property RetentionPolicyList Gets a list of retention policies for this build definition.
Public property Schedules Gets a list of schedules for the build definition.
Public property SourceProviders A list of source providers for the definition
Public property TeamProject Gets the team project that owns this build group item. (Inherited from IBuildGroupItem.)
Public property TriggerType Gets or sets the definition system trigger.
Public property Uri Gets the uniform resource identifier (URI) of this build group item. (Inherited from IBuildGroupItem.)
Public property Workspace Gets the workspace template for the build definition.

Top

Methods

Name Description
Public method AddRetentionPolicy Adds a retention policy to the list of retention policies of this build definition.
Public method AddSchedule Adds a schedule to the list of schedules for the build definition. The schedule has no effect if the ContinuousIntegrationType is not Schedule. Only one schedule is accepted in the list.
Public method CopyFrom Updates the current build definition instance using the property values in the provided build definition.
Public method CreateBuildRequest Creates a build request from the build definition that has values for IBuildAgent and drop location set to the default build agent and default drop location.
Public method CreateManualBuild(String) Creates a build detail record in the Team Foundation Server build database. Build information and other changes can be made to the returned IBuildDetail object.
Public method CreateManualBuild(String, String) Creates a build detail record in the Team Foundation Server build database. Build information and other changes can be made to the returned IBuildDetail object.
Public method CreateManualBuild(String, String, BuildStatus, IBuildController, String) Creates a build detail record in the Team Foundation Server build database.
Public method CreateSpec Creates a new build specification for the build definition.
Public method Delete Deletes the build definition and all its builds from the server.
Public method QueryBuilds Gets all the builds for this build definition.
Public method Refresh() Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public method Refresh(array<String[], QueryOptions) Refresh this build definition by getting updated property values from the server.
Public method Save Saves any changes that were made to the IBuildDefinition object to the server.

Top

Extension Methods

Name Description
Public Extension Method CreateInitialSourceProvider This extension method should no longer be used. It is here for backwards compatibility only. (Defined by BuildServerExtensions.)
Public Extension Method CreateSourceProvider (Defined by BuildServerExtensions.)
Public Extension Method GetDefaultSourceProvider This extension method for IBuildDefinition retuns the first source provider for the definition. If no source provider is listed, an empty TFVC provider is returned. (Defined by BuildServerExtensions.)
Public Extension Method SetSourceProvider This extension method should no longer be used. It is here for backwards compatibility only. (Defined by BuildServerExtensions.)

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace