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 IBuildDefinition : IBuildGroupItem

The IBuildDefinition type exposes the following members.

  NameDescription
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 propertyConfigurationFolderPath Obsolete. Gets or sets the path of the version control folder that contains the build definition project files (TfsBuild.proj and TfsBuild.rsp).
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 propertyDefaultBuildAgent Obsolete. Gets or sets the default build agent to use for this build definition.
Public propertyDefaultBuildAgentUri Obsolete. Gets the URI of the default build agent.
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 propertyEnabledGets 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 propertyRetentionPolicies Obsolete. Gets a dictionary of the retention policies for the build definition. The dictionary is indexed by the build status.
Public propertyRetentionPolicyListGets a list of retention policies for this build definition.
Public propertySchedulesGets a list of schedules for the build definition.
Public propertyTeamProjectGets the team project that owns this build group item. (Inherited from IBuildGroupItem.)
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 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 methodCreateProjectFile Obsolete. Creates an IProjectFile from the build definition with values for the obsolete properties set to values determined by the build definition.
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 methodRefreshRefreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public methodSaveSaves any changes that were made to the IBuildDefinition object to the server.
Top

Community Additions

ADD
Show:
© 2014 Microsoft