Export (0) Print
Expand All

IBuildDefinition Interface

This interface represents a build definition.

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

public interface class IBuildDefinition : IBuildGroupItem

The IBuildDefinition type exposes the following members.

  NameDescription
Public propertyAttachedPropertiesAttached properties
Public propertyBatchSizeThe maximum batch size for queued builds when you use the Gated continuous integration type.
Public propertyBuildControllerGets or sets the build controller that builds this build definition.
Public propertyBuildControllerUriGets the uniform resource identifier (URI) of the build controller that builds this build definition.
Public propertyBuildServerGets the server or computer that is hosting the build definition.
Public propertyContinuousIntegrationQuietPeriodGets or sets the time (in minutes) of the quiet period that is associated with Batch type continuous integration builds.
Public propertyContinuousIntegrationTypeGets or sets the continuous integration type of the build definition.
Public propertyDateCreatedThe date and time at which this build definition was created.
Public propertyDefaultDropLocationGets or sets the default drop location for builds generated by the build definition.
Public propertyDescriptionGets or sets the description for the build definition.
Public propertyEnabled Obsolete. Gets or sets the enabled status of the build definition.
Public propertyFullPathGets the full path of this build group item. (Inherited from IBuildGroupItem.)
Public propertyIdGets the ID of this build definition.
Public propertyLastBuildUriGets the URI of the last build for the build definition, regardless of status.
Public propertyLastGoodBuildLabelGets the name of the label for the last successful build for the build definition.
Public propertyLastGoodBuildUriGets the URI for the last successful build for the build definition.
Public propertyNameGets or sets the name of this build group item. (Inherited from IBuildGroupItem.)
Public propertyProcessGets or sets the build process template for this definition.
Public propertyProcessParametersGets an XML formatted string representing all the process parameters for this build.
Public propertyQueueStatusThe queue status of the build definition.
Public propertyRetentionPolicyListGets a list of retention policies for this build definition.
Public propertySchedulesGets a list of schedules for the build definition.
Public propertySourceProvidersA list of source providers for the definition
Public propertyTeamProjectGets the team project that owns this build group item. (Inherited from IBuildGroupItem.)
Public propertyTriggerTypeGets or sets the definition system trigger.
Public propertyUriGets the uniform resource identifier (URI) of this build group item. (Inherited from IBuildGroupItem.)
Public propertyWorkspaceGets the workspace template for the build definition.
Top

  NameDescription
Public methodAddRetentionPolicyAdds a retention policy to the list of retention policies of this build definition.
Public methodAddScheduleAdds 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 methodCopyFromUpdates the current build definition instance using the property values in the provided build definition.
Public methodCreateBuildRequestCreates 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 methodCreateManualBuild(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 methodCreateManualBuild(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 methodCreateManualBuild(String, String, BuildStatus, IBuildController, String)Creates a build detail record in the Team Foundation Server build database.
Public methodCreateSpecCreates a new build specification for the build definition.
Public methodDeleteDeletes the build definition and all its builds from the server.
Public methodQueryBuildsGets all the builds for this build definition.
Public methodRefresh()Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public methodRefresh(array<String>, QueryOptions)Refresh this build definition by getting updated property values from the server.
Public methodSaveSaves any changes that were made to the IBuildDefinition object to the server.
Top

  NameDescription
Public Extension MethodCreateInitialSourceProviderThis extension method should no longer be used. It is here for backwards compatibility only. (Defined by BuildServerExtensions.)
Public Extension MethodCreateSourceProvider (Defined by BuildServerExtensions.)
Public Extension MethodGetDefaultSourceProviderThis 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 MethodSetSourceProviderThis extension method should no longer be used. It is here for backwards compatibility only. (Defined by BuildServerExtensions.)
Top
Show:
© 2014 Microsoft