java.lang.Object
- jetbrains.buildServer.serverSide.impl.DummyBuildType

All Implemented Interfaces:

Comparable<BuildTypeDescriptor>, BuildType, BuildTypeDescriptor, BuildConfigurationInfo, BuildTypeEx, BuildTypeIdentity, BuildTypeIdentityEx, BuildTypeOptions, BuildTypeSettings, CleanupSettings, CleanupSettingsInit, CompatibleAgents, DependencySettings, Dependent, InheritableUserParametersHolder, InheritableUserParametersHolderEx, InternalParameters, LVcsRootInstanceHolder, LVcsRootInstanceHolderEx, ParametersSupport, ReadOnlyUserParameters, ResolvedSettings, SBuildType, SPersistentEntity, UserParametersHolder, VcsLabelingSettings, VcsWorkspaceAccess, OptionSupport
```
public class DummyBuildType
extends Object
implements BuildTypeEx, ResolvedSettings
```
Author:

Pavel.Sher

Nested Class Summary
- Nested classes/interfaces inherited from interface jetbrains.buildServer.BuildTypeDescriptor
  BuildTypeDescriptor.CheckoutType
- Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions
  BuildTypeOptions.BuildConfigurationType
- Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
  VcsLabelingSettings.LabelingType

Field Summary
- Fields inherited from interface jetbrains.buildServer.BuildTypeDescriptor
  FULL_NAME_SEPARATOR
- Fields inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions
  BT_ALLOW_EXTERNAL_STATUS, BT_ALLOW_PERSONAL_BUILD_TRIGGERING, BT_ARTIFACT_PUBLISH_CONDITION, BT_ARTIFACT_RULES, BT_BRANCH_FILTER, BT_BUILD_CONFIGURATION_TYPE, BT_BUILD_DEFAULT_BRANCH, BT_BUILD_NUMBER_PATTERN, BT_CHECKOUT_DIR, BT_CHECKOUT_MODE, BT_CLEAN_BUILD, BT_EXCLUDE_DEFAULT_BRANCH_CHANGES, BT_EXECUTION_TIMEOUT, BT_FAIL_IF_TESTS_FAIL, BT_FAIL_ON_ANY_ERROR_MESSAGE, BT_FAIL_ON_EXIT_CODE, BT_FAIL_ON_OOME_OR_CRASH, BT_GENERATED_SETTINGS_CHECKSUM, BT_HANGING_BUILDS_DETECTION_ENABLED, BT_MAX_RUNNING_BUILDS, BT_MAX_RUNNING_BUILDS_PER_BRANCH, BT_SHOW_DEPS_CHANGES, BT_SUPPORT_TEST_RETRY, DEFAULT_BUILD_NUMBER_PATTERN, DEFAULT_MAX_RUNNING_BUILDS_PER_BRANCH, DEFAULT_VCS_LABELING_BRANCH_FILTER, VCS_LABELING_BRANCH_FILTER
- Fields inherited from interface jetbrains.buildServer.serverSide.CleanupSettings
  CLEANUP_PREVENT_DEPENDENCIES_ARTIFACTS_FROM_CLEANUP, DISABLE_CLEANUP_POLICIES
- Fields inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
  DEFAULT_LABEL_PATTERN

Constructor Summary

Constructors
Constructor	Description
`DummyBuildType(BuildTypeSettingsEx buildTypeSettings, BranchSpec specs, VcsRootInstancesManagerEx vcsRootInstancesManager, BuildPromotionManagerEx promotionManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addArtifactDependency(SArtifactDependency dependency)`	Adds artifact dependency.
`SBuildFeatureDescriptor`	`addBuildFeature(String type, Map<String,String> params)`	Adds build feature with specified type and parameters to this settings object.
`void`	`addBuildFeature(SBuildFeatureDescriptor feature)`	Adds build feature descriptor to this settings object.
`void`	`addBuildParameter(Parameter parameter)`	Adds build parameter to the configuration.
`SBuildRunnerDescriptor`	`addBuildRunner(String id, String name, String runnerType, Map<String,String> parameters)`	Creates a new build runner with the specified id, name, runner type, and parameters, and adds it to the current build settings.
`SBuildRunnerDescriptor`	`addBuildRunner(String name, String runnerType, Map<String,String> parameters)`	Creates new build runner and adds it to these settings.
`SBuildRunnerDescriptor`	`addBuildRunner(BuildRunnerDescriptor runner)`	Adds runner descriptor.
`BuildTriggerDescriptor`	`addBuildTrigger(String type, Map<String,String> params)`	Adds new trigger of specified type and with specified parameters to build configuration settings.
`boolean`	`addBuildTrigger(BuildTriggerDescriptor triggerDescriptor)`	Adds new trigger to build configuration settings.
`void`	`addCleanupPolicy(HistoryRetentionPolicy policy)`	Sets cleanup policy for this build configuration
`void`	`addConfigParameter(Parameter param)`	Adds configuration parameter.
`void`	`addDependency(Dependency dependOn)`	Add dependency on another build configuration
`void`	`addParameter(Parameter param)`	Adds parameter.
`void`	`addRequirement(Requirement requirement)`	Adds new build requirement to the configuration.
`void`	`addRunParameter(Parameter parameter)`	For tests only!
`void`	`addTemplate(BuildTypeTemplate template, boolean optimizeSettings)`	Attach one more build configuration to a template.
`SQueuedBuild`	`addToQueue(String triggeredBy)`	Adds build instance of the configuration to the queue with the specified requestor name.
`SQueuedBuild`	`addToQueue(BuildAgent agent, String triggeredBy)`	Adds build instance of the configuration to the queue with the specified requestor name on the specified agent (if agent is authorized).
`SQueuedBuild`	`addToQueue(BuildPromotionEx buildPromotion, String triggeredBy)`	Adds build to queue with specified build promotion.
`SQueuedBuild`	`addToQueue(SAgentRestrictor agentRestrictor, BuildPromotionEx buildPromotion, String triggeredBy)`	Adds build to queue on the specified agent with manually set build parameters: these build parameters will redefined build parameters specified within this build configuration
`boolean`	`addVcsRoot(SVcsRoot root)`	Adds VCS root to the build configuration with default checkout rules.
`void`	`applyRunnersOrder(String[] ids)`	Accepts array of runner identifiers and reorders them according to this array.
`void`	`attachedToModel(ProjectDataModel model)`
`void`	`attachToTemplate(BuildTypeTemplate template)`	Attaches this build configuration to the specified template.
`void`	`attachToTemplate(BuildTypeTemplate template, boolean changeVcsRootsScope)`	Attaches this build configuration to the specified template
`boolean`	`belongsTo(SProject project)`	Checks whether this build type or template belongs to the specified project or one of its subprojects, transitively.
`void`	`branchesChanged(boolean currentNodeEvent, Date branchChangeTimestamp)`	Notifies build configuration that the branches may have changed.
`boolean`	`canListFiles()`
`void`	`clearPrevPromotionCache(Collection<BuildPromotion> targetPromos)`
`int`	`compareTo(BuildTypeDescriptor o)`
`boolean`	`containsOwnVcsRoot(long vcsRootId)`	Returns true if VCS root with specified id is attached directly and is not inherited via a template
`boolean`	`containsVcsRoot(long vcsRootId)`	Returns true if VCS root with specified id is attached directly or is inherited via a template
`BuildCustomizer`	`createBuildCustomizer(SUser user)`	Creates `BuildCustomizer` that can be used to create custom promotions for this build type
`BuildPromotionEx`	`createBuildPromotion()`	Creates new build promotion which then can be used when build is added to a queue.
`BuildPromotionEx`	`createBuildPromotion(String branchName)`	Creates build promotion graph and sets specified branch name to all its nodes.
`BuildPromotionEx`	`createBuildPromotion(String branchName, BuildPromotionInitializer initializer)`	Same as `BuildTypeEx.createBuildPromotion(String)` but accepts initializer which is called for every new build promotion in the created build chain
`BuildPromotionEx`	`createBuildPromotion(String branchName, BuildPromotionInitializer initializer, DependenciesSupplier dependenciesSupplier)`	Same as `BuildTypeEx.createBuildPromotion(String)` but accepts initializer and dependencies supplier.
`ConfigAction`	`createConfigAction(SUser user, String description)`	Creates a config action instance associated with this entity and having the specified description.
`BuildTypeEx`	`createEditableCopy(boolean fillSettings)`
`RemoteBuildTypeEx`	`createPersonalBuildType(User user, long changeListId)`	Creates personal build type, i.e.
`RemoteBuildTypeEx`	`createPersonalBuildType(User user, String comment)`	Creates personal build type, i.e.
`RemoteBuildTypeEx`	`createPersonalBuildType(User user, String comment, Map<VcsRootInstance,VcsRootInstance> overridenRoots)`	Create personal build type that starts build with overriden roots.
`void`	`detachFromTemplate()`	Detaches build configuration from all templates, except for the default one if present.
`void`	`dispose()`	Must be called when this build configuration object is removed from the model.
`SBuildFeatureDescriptor`	`findBuildFeatureById(String featureId)`	Returns build feature with specified id
`SBuildRunnerDescriptor`	`findBuildRunnerById(String runnerId)`	Finds build runner by its' id
`SBuildRunnerDescriptor`	`findBuildRunnerByType(String runnerType)`	Returns first build runner of specified type or null
`String`	`findRunnerParameter(String paramName)`	Searches runner parameter in all build runners and returns value of the first found parameter with given name.
`Collection<BuildTypeEx>`	`findTops()`
`BuildTriggerDescriptor`	`findTriggerById(String triggerId)`	Finds build trigger descriptor by its' id
`void`	`forceCheckingForChanges()`	Starts checking for changes for all VCS roots of this build configuration
`void`	`forceCheckingForChanges(OperationRequestor requestor)`	Starts checking for changes for all VCS roots of this build configuration
`List<BranchEx>`	`getActiveBranches()`
`Set<String>`	`getAdditionalBranchesForChangesCollecting(LVcsRootInstance root, VcsRepositoryState state)`
`List<BranchSpec>`	`getAdditionalBranchSpecs(LVcsRootInstance root, VcsRepositoryState state)`
`List<BranchSpec>`	`getAdditionalBranchSpecs(VcsRootInstance root, VcsRepositoryState state)`
`List<AgentCompatibility>`	`getAgentCompatibilities()`	Returns information about what agent are compatible with the configuration, what are incompatible and why.
`CompatibilityResult`	`getAgentCompatibility(AgentDescription agentDescription)`	Fetches compatibility information for given agent description
`AgentCompatibility`	`getAgentCompatibility(SBuildAgent agent)`	Returns information about agent compatibility for the specified agent.
`List<SBuildAgent>`	`getAgentsWhereBuildConfigurationBuilt()`	Returns list of agents (sorted by name) where this build configuration was ever built.
`AgentCompatibility`	`getAgentTypeCompatibility(SAgentType agentType)`
`List<SArtifactDependency>`	`getArtifactDependencies()`	Returns artifacts this build configuration depending on.
`List<File>`	`getArtifactDirectories()`
`String`	`getArtifactPaths()`	Returns build artifact paths.
`File`	`getArtifactsDirectory()`	Returns directory containing artifacts of this build configuration.
`List<SBuildType>`	`getArtifactsReferences()`	Returns list of build configurations which depend on this build configurations artifacts
`BranchEx`	`getBranch(String name)`
`BranchEx`	`getBranchByDisplayName(String branchDisplayName)`	Returns a branch by its display name.
`List<BranchEx>`	`getBranches(BranchCalculationOptions branchCalculationOptions)`
`List<BranchEx>`	`getBranches(BranchesPolicy policy, Boolean includeBranchesFromDependencies)`
`List<BranchEx>`	`getBranches(BranchesPolicy policy, Boolean includeBranchesFromDependencies, boolean computeTimestamps)`
`BranchSpec`	`getBranchSpec(LVcsRootInstance root)`
`BranchSpec`	`getBranchSpec(SVcsRoot root)`	Returns branch specification for specified parent root
`BranchSpec`	`getBranchSpec(VcsRootInstance root)`
`Build`	`getBuildByBuildNumber(String buildNumber)`	Returns most recent build instance with specified build number.
`long`	`getBuildDuration(BuildAgent agent)`	Returns estimated duration of a build on the specified agent.
`List<Requirement>`	`getBuildFeatureRequirements()`	Returns list of additional agent requirements imposed by configured enabled build features.
`Collection<SBuildFeatureDescriptor>`	`getBuildFeatures()`	Returns build features added to this settings object.
`Collection<SBuildFeatureDescriptor>`	`getBuildFeaturesOfType(String featureType)`	Returns all build features of specified type.
`String`	`getBuildNumberPattern()`	Returns current build number pattern
`BuildNumbers`	`getBuildNumbers()`	Returns interface to manipulate current build counter
`String`	`getBuildParameter(String key)`	Returns build parameter by parameter key
`Map<String,String>`	`getBuildParameters()`	Returns the map of build parameters specified by user.
`Collection<Parameter>`	`getBuildParametersCollection()`	Returns build parameters collection.
`List<SBuildRunnerDescriptor>`	`getBuildRunners()`	Returns collection of build runners attached to these settings
`BuildSettings`	`getBuildSettings()`	Returns build settings: settings for build (where excluded disabled options and features).
`Collection<BuildTriggerDescriptor>`	`getBuildTriggerDescriptors(String triggerName, boolean enabledOnly)`
`Collection<BuildTriggerDescriptor>`	`getBuildTriggersCollection()`	Returns collection of build trigger settings
`BranchFilter`	`getBuildTypeBranchFilter()`
`BranchFilter`	`getBuildTypeBranchFilterUnsafe()`	Same as `SBuildType.getBuildTypeBranchFilter()` but throws an exception if the branch filter is incorrect
`String`	`getBuildTypeId()`	Returns build configuration internal id.
`BuildTypeOrderedBuilds`	`getBuildTypeOrderedBuilds()`
`List<BuildAgentEx>`	`getCanRunAgents()`	Returns list of agents where this build configuration can run.
`List<BuildAgentEx>`	`getCanRunAndCompatibleAgents(boolean includeDisabled)`	Returns list of agents which are both allowed to run this configuration and are compatible with it.
`List<StartableAgentType>`	`getCanRunAndCompatibleAgentTypes()`	Returns list of cloud agent types which are both allowed to run this configuration and are compatible with it.
`Option[]`	`getChangedOptions()`	Return options with changed values, i.e.
`String`	`getCheckoutDirectory()`	Returns build checkout directory - if specified explicitly using `BuildTypeSettings.setCheckoutDirectory(String)`.
`CheckoutRules`	`getCheckoutRules(VcsRoot root)`	Returns checkout rules configured for the specified VCS root.
`BuildTypeDescriptor.CheckoutType`	`getCheckoutType()`	Returns method used by agent to retrieve project sources.
`Collection<SBuildType>`	`getChildDependencies()`	Returns all child dependencies collected down the chain.
`Map<String,Boolean>`	`getCleanupOptions()`
`Collection<HistoryRetentionPolicy>`	`getCleanupPolicies()`
`Map<SBuildAgent,CompatibilityResult>`	`getCompatibilityMap()`	Returns compatibility map, key is an agent and value is compatibility result.
`Collection<SBuildAgent>`	`getCompatibleAgents()`	Returns collection of compatible agents
`String`	`getConfigId()`	Returns the entity's config identifier.
`Map<String,String>`	`getConfigParameters()`	Returns map of configuration parameters
`Collection<Parameter>`	`getConfigParametersCollection()`	Returns collection of configuration parameters.
`File`	`getConfigurationFile()`	Returns the configuration file where this build type or template is persisted (or will be persisted to).
`File`	`getConfigurationFile(File projectsDir)`	Returns the configuration file where this entity is persisted in custom projects directory
`CustomDataStorage`	`getCustomDataStorage(String storageId)`	Returns custom data storage associated with this build configuration.
`String`	`getDefaultBranchDisplayName()`	Returns a display name of the default branch according to the current settings of all VCS roots attached to build configuration (their default branch vcs names and branch specs).
`Map<SBuildType,DependencyOptions>`	`getDependedOnMe()`
`List<Dependency>`	`getDependencies()`	Get existing dependencies, empty collection when no dependencies exist
`BuildTypeDependencyGraph`	`getDependencyGraph()`
`List<SBuildType>`	`getDependencyReferences()`	Returns list of build configurations directly referencing this build configuration.
`String`	`getDescription()`	Returns configuration description.
`List<ChangeDescriptor>`	`getDetectedChanges(SelectPrevBuildPolicy policy)`
`List<ChangeDescriptor>`	`getDetectedChanges(SelectPrevBuildPolicy prevBuildPolicy, Boolean includeDependencyChanges)`
`DummyBuild`	`getDummyBuild()`
`DummyBuildPromotion`	`getDummyBuildPromotion()`
`DummyBuildPromotion`	`getDummyBuildPromotion(boolean createIfNotExists)`
`EntityId<String>`	`getEntityId()`	Returns the instance of the entity identifier.
`Set<Long>`	`getExcludedDefaultRootInstanceIds()`	Returns set of vcs root instance ids with excluded default branch
`int`	`getExecutionTimeoutMin()`	Returns duration the build allowed to run until killed by the server.
`String`	`getExtendedFullName()`	Returns the full name of build configuration with additional note if the project is archived.
`String`	`getExtendedName()`	Returns the name of build configuration with additional note if the project is archived.
`String`	`getExternalId()`	Returns the external identifier.
`byte[]`	`getFileContent(String relativePath)`	Get binary content of the latest version of a file related to this build type.
`byte[]`	`getFileContent(String relativePath, boolean latest)`	Same as {@link #getFileContent(String, false)}
`String`	`getFullName()`	Name of the project and name of the identity.
`List<SFinishedBuild>`	`getHistory()`	See also `BuildHistory.processEntries(jetbrains.buildServer.util.ItemProcessor)`
`List<SFinishedBuild>`	`getHistory(User user, boolean includeCanceled, boolean orderByChanges)`	Returns all finished builds, visible for the specified user of this configuration.
`List<SFinishedBuild>`	`getHistoryFull(boolean orderByChanges)`	See also `BuildHistory.processEntries(String, jetbrains.buildServer.users.User, boolean, boolean, boolean, jetbrains.buildServer.util.ItemProcessor)`
`String`	`getId()`	Returns build configuration internal id
`List<Requirement>`	`getImplicitRequirements()`	Get list of non-satisfied implicit requirements for build agents.
`Map<String,Boolean>`	`getInheritedCleanupOptions()`
`Collection<HistoryRetentionPolicy>`	`getInheritedCleanupPolicies()`
`Collection<Parameter>`	`getInheritedParametersCollection()`
`String`	`getInternalId()`	Returns the internal identifier.
`List<VcsRoot>`	`getLabelingRoots()`	List of roots which should be processed by labeling process
`VcsLabelingSettings.LabelingType`	`getLabelingType()`
`String`	`getLabelPattern()`
`SFinishedBuild`	`getLastChangesFinished()`	Returns last finished instance for the build configuration with last user changes (personal builds and canceled builds are excluded).
`SBuild`	`getLastChangesStartedBuild()`	Returns instance of the build, finished or running, which contains latest changes in this build configuration
`SFinishedBuild`	`getLastChangesSuccessfullyFinished()`	Returns last successfully finished build in the configuration with last user changes, personal builds are not considered
`AuditLogAction`	`getLastConfigModificationAction()`
`Comment`	`getLastPauseComment()`	Differs from `SBuildType.getPauseComment()` - it returns last comment for pause action only.
`BranchSpec`	`getLastUsedBranchSpec(SVcsRoot parentRoot)`	Returns branch specification used for changes collecting in given VCS root.
`Map<VcsRootInstance,BranchSpec>`	`getLastUsedBranchSpecMap()`
`Map<VcsRootInstance,BranchSpec>`	`getLastUsedBranchSpecMap(boolean includeSettingsRoot)`
`List<SBuild>`	`getLatestBuilds()`
`Set<String>`	`getLogicalBranchNames(VcsRootInstance root, String vcsBranch)`	Returns set of possible logical names for the given VCS branch in the given VCS root according to current VCS root settings (i.e.
`int`	`getMaximumNumberOfBuilds()`	Returns maximum number of simultaneously running builds.
`String`	`getMaximumNumberOfBuildsPerBranch()`
`List<SVcsModification>`	`getModificationsSinceLastSuccessful()`	Returns all modifications made since last successfully finished build
`String`	`getName()`	The name of the identity.
`int`	`getNumberOfArtifactReferences()`	Returns number of dependent build configuration having references to this build configuration.
`int`	`getNumberOfDependencyReferences()`	Returns number of dependency references (the number includes all references even those which are not available because of permissions)
`int`	`getNumberQueued()`	Returns number of items for this build configurations currently waiting in queue
`<T> T`	`getOption(Option<T> option)`	Get option value
`<T> T`	`getOptionDefaultValue(Option<T> option)`
`Collection<Option>`	`getOptions()`
`Map<String,Boolean>`	`getOwnCleanupOptions()`
`Collection<HistoryRetentionPolicy>`	`getOwnCleanupPolicies()`
`List<Dependency>`	`getOwnDependencies()`	Returns list of own dependencies (not inherited from a template).
`Parameter`	`getOwnNonInheritedParameter(String paramName)`	Own parameter without inherited parameter spec.
`Collection<Option>`	`getOwnOptions()`	Return options defined in this object, i.e.
`Parameter`	`getOwnParameter(String paramName)`
`Map<String,String>`	`getOwnParameters()`
`Collection<Parameter>`	`getOwnParametersCollection()`
`Collection<Parameter>`	`getOwnParametersWithoutInheritedSpec()`
`List<? extends BuildTypeTemplate>`	`getOwnTemplates()`	Returns a list of templates to which the build configuration is directly attached.
`Collection<String>`	`getOwnVcsBranchNames(boolean activeOnly)`
`List<VcsRootEntry>`	`getOwnVcsRootEntries()`
`Parameter`	`getParameter(String paramName)`
`Map<String,String>`	`getParameters()`	Returns map of build and configuration parameters.
`Collection<Parameter>`	`getParametersCollection()`	Returns build and configuration parameters in single collection.
`ParametersProvider`	`getParametersProvider()`	Returns parameters which can be used by value resolver.
`String`	`getParameterValue(String paramName)`
`SPersistentEntity`	`getParent()`	The parent entity.
`Comment`	`getPauseComment()`	Returns comment for pausing/resuming this build type
`List<SVcsModification>`	`getPendingChanges()`	Returns changes in this build configuration already detected but not associated with a build.
`Collection<SUser>`	`getPendingChangesCommitters()`	Returns pending changes committers to this build configuration
`List<ChangeDescriptor>`	`getPendingChangesInAllBranches(Boolean includeDependencyChanges)`	Returns pending changes detected in all branches of this build configuration.
`List<ChangeDescriptor>`	`getPendingChangesInAllBranches(Boolean includeDependencyChanges, VcsModificationProcessor callback)`
`ProjectEx`	`getProject()`	Returns the project this build type entity belongs to.
`String`	`getProjectExternalId()`	Returns external id of the project this build configuration configured in.
`String`	`getProjectId()`	Returns internal id of the project this build configuration configured in.
`String`	`getProjectName()`	Returns project name this configuration belongs to.
`List<SQueuedBuild>`	`getQueuedBuilds()`
`List<SQueuedBuild>`	`getQueuedBuilds(User user)`	If user is null or has "Show personal builds of other users" enabled, returns all queued builds including all personal builds.
`Map<String,DependencyOptions>`	`getRawDependedOnMe()`	Map from internal build type id to dependency options
`ReadOnlyReason`	`getReadOnlyReason()`
`Set<Long>`	`getRelatedVcsRootInstanceIds()`	Returns ids of VCS root instances which reported changes associated with this build configuration.
`List<Requirement>`	`getRequirements()`	Get list of explicit requirements for build agents which can run this build configuration.
`Collection<BuildTriggerDescriptor>`	`getResolvedBuildTriggerDescriptors(boolean enabledOnly)`
`Collection<BuildTriggerDescriptor>`	`getResolvedBuildTriggerDescriptors(String triggerName, boolean enabledOnly)`
`ResolvedSettings`	`getResolvedSettings()`	Returns resolved settings of this build configuration (with parameter references substituted)
`ResponsibilityEntry`	`getResponsibilityInfo()`	Returns the information about responsibility on this build configuration.
`String`	`getRunBuildActionName()`
`BuildStepConditions`	`getRunnerConditions(SBuildRunnerDescriptor descriptor)`
`String[]`	`getRunnersOrder()`
`Collection<String>`	`getRunnerTypes()`	Returns collection of types of enabled build runners configured in this configuration
`List<SRunningBuild>`	`getRunningBuilds()`	Same as getRunningBuilds(null)
`List<SRunningBuild>`	`getRunningBuilds(User user)`	See `BuildType.getRunningBuilds(User)`
`List<Requirement>`	`getRunTypeRequirements()`	Returns list of additional agent requirements imposed by configured runners.
`BuildTypeSettingsEx`	`getSettings()`
`SBuildType`	`getSourceBuildType()`	If current instance is an instance of RemoteBuildType - returns base configuration for remote build type, otherwise - returns this.
`Status`	`getStatus()`	Returns current status of the configuration.
`BuildTypeStatusDescriptor`	`getStatusDescriptor()`	Returns current status of the configuration with text description and status build.
`List<String>`	`getTags()`	List of all tags set for builds of this configuration.
`List<String>`	`getTags(SUser user)`	List of all private tags set for builds of this configuration by the specified user.
`BuildTypeTemplate`	`getTemplate()`	Returns the first template these settings are based on.
`String`	`getTemplateId()`	Returns internal id of the first template this setting is based on
`List<String>`	`getTemplateIds()`	Returns internal ids of the templates this settings are based on, including one of the default template
`List<? extends BuildTypeTemplate>`	`getTemplates()`	Returns templates these settings are based on, including the default template.
`List<SBuildType>`	`getTransitiveDependedOnMe()`	Returns all build configurations collected up the dependency chain.
`List<String>`	`getUndefinedParameters()`	Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided.
`ValueResolver`	`getValueResolver()`	Returns value resolver which can be used to resolve references in values
`Browser`	`getVcsFilesBrowser()`
`Browser`	`getVcsFoldersBrowser()`
`List<VcsRootEntry>`	`getVcsRootEntries()`	Returns all entries of vcs roots.
`List<VcsRootInstanceEntry>`	`getVcsRootInstanceEntries()`
`List<VcsRootInstanceEntry>`	`getVcsRootInstanceEntries(boolean includeSettingsRoot)`	Returns entries for VCS roots attached to this buildType.
`List<VcsRootInstanceEntry>`	`getVcsRootInstanceEntries(Set<String> vcsNames, boolean includeSettingsRoot)`	Returns entries corresponding to specified vcs support names
`VcsRootInstanceEntry`	`getVcsRootInstanceEntryForParent(SVcsRoot parentRoot)`
`VcsRootInstance`	`getVcsRootInstanceForParent(SVcsRoot parentRoot)`
`List<VcsRootInstance>`	`getVcsRootInstances()`
`List<SVcsRoot>`	`getVcsRoots()`	Returns all roots currently attached to this configuration
`String`	`getVcsRootsHash()`	Returns build configuration vcs roots hash without taking checkout directory into account The resulting hash is an equal to the default checkout directory (since 10.0 it is true only for not auto checkout type).
`String`	`getVcsRootsHash(BuildTypeDescriptor.CheckoutType checkoutType)`	Returns build configuration vcs roots hash without taking checkout directory into account The resulting hash is an equal to the default checkout directory.
`String`	`getVcsSettingsHash()`	Returns build configuration vcs settings hash.
`String`	`getVcsSettingsHash(List<VcsRootInstanceEntry> vcsRootEntries)`	Return name of the directory which should be used as checkout directory for this build configuration if explicit checkout directory is not specified.
`PersistentEntityVersion`	`getVersion()`	Returns version of this entity which can be used to check if the entity was edited or persisted.
`boolean`	`hasBuilds()`
`boolean`	`hasOwnBranches()`
`BuildTypeEx`	`inline()`	Creates a temporary copy of this buildType with all settings inherited from a project or a template inlined.
`boolean`	`intersectsWith(Dependent dependent)`	Returns true if this object dependencies intersect (have same nodes) with specified object dependencies.
`boolean`	`isAgentLessBuildType()`
`boolean`	`isAllowExternalStatus()`	Returns if viewing of the configuration status is allowed externally.
`boolean`	`isBranchSpecDefined(boolean processDependencies)`
`boolean`	`isBranchSpecDefined(boolean processDependencies, boolean processSettingsRoot)`
`boolean`	`isCleanBuild()`	Returns if all files on an agent machine should be deleted before the build is started.
`boolean`	`isCompositeBuildType()`
`boolean`	`isDefaultBranchExcluded()`	Returns true default branch is excluded in the build configuration branch filter
`boolean`	`isDeployment()`
`boolean`	`isEmptyUuid()`
`boolean`	`isEnabled(String paramsDescriptorId)`	Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.
`boolean`	`isImplicitSettingsRoot(VcsRootInstance root)`	Returns true if the specified VCS root is an implicit settings root, ie.
`boolean`	`isInQueue()`	Returns true if the configuration is queued at the moment
`boolean`	`isPaused()`	Returns if the configuration is paused.
`boolean`	`isPersonal()`	Returns if the configuration is temporary created for the personal build.
`boolean`	`isReadOnly()`
`boolean`	`isShouldFailBuildIfTestsFailed()`	Returns `true` if build of the configuration has to fail if there is failed test.
`boolean`	`isTemplateAccessible()`	Checks accessibility of all attached templates, excluding the default template (if present)
`boolean`	`isTemplateBased()`	Returns true if these settings are directly based on a template.
`boolean`	`isValidVcsBranch(String name, boolean includeBranchesFromDependencies)`
`boolean`	`isVirtual()`
`List<VcsFile>`	`listFiles(String relativePath)`	Lists files in the directory specified by relativePath
`PathMapping`	`mapVcsPath(String path)`	Returns path mapping for the given full VCS path of a file if this path can correspond to any of the project's VCS roots.
`void`	`markPersisted(long expectedEditId)`	Marks entity as persisted
`void`	`moveToProject(ConfigAction cause, SProject target)`	Moves this build configuration to the `target` project.
`void`	`moveToProject(SProject target)`	Moves this build configuration to the `target` project.
`void`	`moveToProject(SProject target, boolean changeScopeOfLocalRoots)`	Moves this build configuration to the `target` project.
`RunningBuildEx`	`newAgentLessBuild(QueuedBuildEx queuedBuild, SBuildAgent buildAgent, Date removeFromQueueTime)`	Creates new SRunningBuild instance and sets executor name as a build promotion attribute for the purposes of Executor mode builds.
`RunningBuildEx`	`newRunningBuild(QueuedBuildEx queuedBuild, SBuildAgent buildAgent, Date removeFromQueueTime)`	Creates new SRunningBuild instance.
`void`	`persist()`	Persists this entity instance onto disk.
`void`	`persist(String comment)`
`void`	`persist(ConfigAction cause)`	Persists this entity on disk.
`void`	`processHistoryEntries(ItemProcessor<SFinishedBuild> itemProcessor)`	Invokes the given ItemProcessor for all history records of this build type.
`void`	`reassignIntId(String internalId)`	Assigns the specified internalId to this buildType.
`void`	`releaseSources()`	Releases sources of the build configuration on ALL agents where this configuration built.
`void`	`releaseSources(SBuildAgent agent)`	Releases sources of the build configuration on specified agent only.
`boolean`	`rememberLastUsedRootInstanceAndBranchSpec(LVcsRootInstance rootInst, BranchSpec spec)`	Stores branch specification used for changes collecting in given VCS root and resets a pending changes cache if root or spec is changed since last call to this method or when `forcePendingChangesReset` is true
`void`	`remove()`	Removes this entity.
`void`	`removeAllBuildRunners()`	Removes all build runners
`void`	`removeArtifactDependency(SArtifactDependency dependency)`	Removes artifact dependency.
`SBuildFeatureDescriptor`	`removeBuildFeature(String featureId)`	Removes build feature with specified id from this settings object.
`void`	`removeBuildParameter(String paramName)`	Removes existing build parameter by its name.
`SBuildRunnerDescriptor`	`removeBuildRunner(String runnerId)`	Removes runner descriptor with specified id.
`boolean`	`removeBuildTrigger(BuildTriggerDescriptor triggerDescriptor)`	Removes specified build trigger from the settings
`void`	`removeCleanupPolicies()`	Remove all own cleanup policies for the object
`void`	`removeConfigParameter(String paramName)`	Removes configuration parameters with specified name
`boolean`	`removeDependency(Dependency dependOn)`	Remove dependency on another build configuration
`void`	`removeParameter(String paramName)`	Removes parameter.
`void`	`removeRequirement(String propertyName)`	Removes first requirement with the specified property name from the configuration.
`void`	`removeRequirement(Requirement requirement)`	Removes a requirement from the configuration.
`void`	`removeResponsible(boolean buildWasFixed, User responsibleUser, String comment, User whoPerformsTheAction)`	Removes responsible information , mark it is either 'fixed' or 'not fixed'.
`void`	`removeTemplates(Collection<? extends BuildTypeTemplate> templates, boolean inlineSettings)`	Detaches build configuration from a number of templates.
`boolean`	`removeVcsRoot(SVcsRoot root)`	Removes existing VCS root from the build configuration.
`boolean`	`replaceInValues(String regexp, String replacement)`	Replaces values according to specified regexp and replacement string in all text parameters of the build configuration
`boolean`	`replaceInValues(Pattern regexpPattern, String replacement)`	Replaces values according to specified pattern and replacement string in all text parameters of the build configuration
`boolean`	`replaceVcsRoot(SVcsRoot oldVcsRoot, SVcsRoot newVcsRoot)`	Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entries
`void`	`resetPendingChanges()`
`void`	`resetRunnersOrder()`	Resets custom runner order to default.
`PersistTask`	`schedulePersisting(String reason)`	Schedules background persisting of this entity settings.
`PersistTask`	`schedulePersisting(ConfigAction cause)`	Schedules background persisting of this project settings.
`PersistTask`	`scheduleRemove(ConfigAction cause)`	Schedules remove of this persistent entity.
`void`	`sendExtIdChangedEvents(ConfigAction cause, String oldExternalId, String newExternalId)`	This method can be used to send external id changed event.
`void`	`setArtifactDependencies(List<SArtifactDependency> artifacts)`	Sets artifacts this build configuration depending on.
`void`	`setArtifactPaths(String artifactPaths)`	Sets build artifact paths.
`void`	`setBuildNumberPattern(String pattern)`	Sets build number pattern.
`void`	`setCheckoutDirectory(String dir)`	Sets build checkout directory.
`boolean`	`setCheckoutRules(VcsRoot root, CheckoutRules checkoutRules)`	Sets checkout rules for specified VCS root.
`void`	`setCheckoutType(BuildTypeDescriptor.CheckoutType type)`	Sets preferred checkout type for the configuration sources.
`void`	`setCleanupOption(String option, Boolean value)`	Sets value for a cleanup option
`void`	`setDescription(String description)`	Changes configuration description.
`void`	`setEditable(boolean editable)`	Enables or disables editing of the build type in web UI, see also `SPersistentEntity.isReadOnly()`.
`void`	`setEnabled(String paramsDescriptorId, boolean enabled)`	Enables or disables descriptor with specified id in build configuration settings.
`void`	`setExternalId(String newExternalId)`	Changes the external id of this build template or build configuration.
`void`	`setExternalId(ConfigAction cause, String newExternalId)`	Changes the external id of this build template or build configuration.
`void`	`setExternalId(ConfigAction configAction, String newId, boolean sendEvents)`	Same as {`BuildTypeIdentity.setExternalId(ConfigAction, String)`} but provides control over events processing.
`void`	`setName(String newName)`	Sets name of this build type or template
`<T> void`	`setOption(Option<T> option, T value)`	Set option value, clears value if it is the same as default
`void`	`setPaused(boolean paused, User user)`	Pause/unpause this build configuration.
`void`	`setPaused(boolean paused, User user, String comment)`	Pause/unpause this build configuration.
`void`	`setResponsible(User responsibleUser, String userComment, User reporterUser)`	Called when a user takes a responsibility for the build type.
`void`	`setSettings(BuildTypeSettingsEx newSettings)`	Complete replacement of settings
`void`	`setTemplates(List<? extends BuildTypeTemplate> templates, boolean optimizeSettings)`	Replaces templates the build configuration is attached to.
`void`	`setTemplatesOrder(List<String> templatesOrder)`	Imposes new order on the templates the build configuration is attached to.
`boolean`	`setVcsRoots(Collection<SVcsRoot> vcsRoots)`	Sets VCS roots.
`boolean`	`textValueMatches(Pattern regexpPattern)`	Returns true if configuration has value in text parameters which matches specified pattern.
`void`	`traverseDependedOnMe(DependencyConsumer<BuildTypeEx> consumer)`
`void`	`traverseDependencies(DependencyConsumer<BuildTypeEx> consumer)`
`void`	`traverseSelfAndDependedOnMe(DependencyConsumer<BuildTypeEx> consumer)`
`void`	`traverseSelfAndDependencies(DependencyConsumer<BuildTypeEx> consumer)`
`void`	`unregister()`	Must be called when this build configuration was removed from the project completely (calls dispose too).
`boolean`	`updateBuildFeature(String featureId, String newType, Map<String,String> newParams)`	Updates build feature descriptor with specified id, changes type and parameters.
`boolean`	`updateBuildRunner(String runnerId, String name, String type, Map<String,String> params)`	Updates parameters in the existing build runner descriptor.
`boolean`	`updateBuildTrigger(String triggerId, String newType, Map<String,String> newParams)`	Updates build trigger descriptor with specified id, changes type and parameters.
`boolean`	`updateBuildTrigger(BuildTriggerDescriptor newDescriptor)`	Updates build trigger descriptor with id equal to newDescriptor id.
`void`	`updateRevisionsForOwnBranches(Collection<String> logicalBranchNames)`	Make sure that revisions for specified logical branches are calculated and saved in dummy build promotions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeEx
getDeclaredOption, getTypedOption

Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolderEx
getOwnAndParentsNonInheritedParameter, getOwnAndParentsNonInheritedParameters

Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters
getBooleanInternalParameter, getBooleanInternalParameterOrTrue, getInternalParameterValue

- Constructor Detail
  - DummyBuildType
```
public DummyBuildType(@NotNull
                      BuildTypeSettingsEx buildTypeSettings,
                      @NotNull
                      BranchSpec specs,
                      @NotNull
                      VcsRootInstancesManagerEx vcsRootInstancesManager,
                      @NotNull
                      BuildPromotionManagerEx promotionManager)
```
- Method Detail
  - getEntityId
```
@NotNull
public EntityId<String> getEntityId()
```
    Description copied from interface: BuildTypeIdentityEx
    
    Returns the instance of the entity identifier.
    This instance (not a copy!) that contains immutable internal id and modifiable external id. When one has changed the external id of this build template or configuration, the external id incide this class instance will be changed too.
    
    Specified by:
    
    getEntityId in interface BuildTypeIdentityEx
    
    Returns:
    
    the instance of the entity identifier.
  - getInternalId
```
@NotNull
public String getInternalId()
```
    Description copied from interface: BuildTypeIdentity
    
    Returns the internal identifier.
    
    Specified by:
    
    getInternalId in interface BuildTypeIdentity
    
    Returns:
    
    the internal identifier.
  - getName
```
@NotNull
public String getName()
```
    Description copied from interface: BuildTypeIdentity
    
    The name of the identity.
    
    Specified by:
    
    getName in interface BuildTypeDescriptor
    
    Specified by:
    
    getName in interface BuildTypeIdentity
    
    Specified by:
    
    getName in interface LVcsRootInstanceHolder
    
    Specified by:
    
    getName in interface SPersistentEntity
    
    Returns:
    
    see above.
    
    See Also:
    
    BuildTypeIdentity.getFullName(), BuildTypeIdentity.setName(String)
  - getFullName
```
@NotNull
public String getFullName()
```
    Description copied from interface: BuildTypeIdentity
    
    Name of the project and name of the identity.
    
    Specified by:
    
    getFullName in interface BuildTypeDescriptor
    
    Specified by:
    
    getFullName in interface BuildTypeIdentity
    
    Returns:
    
    see above
    
    See Also:
    
    BuildTypeIdentity.getName()
  - getDescription
```
public String getDescription()
```
    Description copied from interface: BuildTypeDescriptor
    
    Returns configuration description.
    
    Specified by:
    
    getDescription in interface BuildTypeDescriptor
    
    Returns:
    
    configuration description.
  - getBuildTypeId
```
@NotNull
public String getBuildTypeId()
```
    Description copied from interface: BuildTypeDescriptor
    
    Returns build configuration internal id. Cannot be changed.
    
    Specified by:
    
    getBuildTypeId in interface BuildTypeDescriptor
    
    Specified by:
    
    getBuildTypeId in interface LVcsRootInstanceHolder
    
    Returns:
    
    unique id
  - getConfigId
```
@NotNull
public String getConfigId()
```
    Description copied from interface: SPersistentEntity
    
    Returns the entity's config identifier. Config identifier uniquely identifies the entity across different TeamCity servers and can't be modified in contrast to external identifier.
    
    Specified by:
    
    getConfigId in interface SPersistentEntity
  - getExternalId
```
@NotNull
public String getExternalId()
```
    Description copied from interface: BuildTypeIdentity
    
    Returns the external identifier.
    
    Specified by:
    
    getExternalId in interface BuildTypeDescriptor
    
    Specified by:
    
    getExternalId in interface BuildTypeIdentity
    
    Specified by:
    
    getExternalId in interface SPersistentEntity
    
    Returns:
    
    the external identifier.
  - getProjectName
```
@NotNull
public String getProjectName()
```
    Description copied from interface: BuildTypeDescriptor
    
    Returns project name this configuration belongs to.
    
    Specified by:
    
    getProjectName in interface BuildTypeDescriptor
    
    Returns:
    
    parent project name.
  - getImplicitRequirements
```
@NotNull
public List<Requirement> getImplicitRequirements()
```
    Description copied from interface: BuildTypeSettings
    
    Get list of non-satisfied implicit requirements for build agents. Implicit requirements appear when some build configuration property, or run parameter contains a reference to another parameter in form %<param name>%.
    
    Specified by:
    
    getImplicitRequirements in interface BuildTypeSettings
    
    Returns:
    
    see above
  - getHistory
```
public List<SFinishedBuild> getHistory()
```
    Description copied from interface: SBuildType
    
    See also BuildHistory.processEntries(jetbrains.buildServer.util.ItemProcessor)
    
    Specified by:
    
    getHistory in interface SBuildType
    
    Returns:
    
    all non-cancelled builds non-personal builds for this build configuration, ordered by build start time descending (recent first)
  - getHistoryFull
```
public List<SFinishedBuild> getHistoryFull(boolean orderByChanges)
```
    Description copied from interface: SBuildType
    
    See also BuildHistory.processEntries(String, jetbrains.buildServer.users.User, boolean, boolean, boolean, jetbrains.buildServer.util.ItemProcessor)
    
    Specified by:
    
    getHistoryFull in interface SBuildType
    
    Parameters:
    
    orderByChanges - if true, builds are ordered by changes, i.e. most recent build with recent changes goes first; if false, most recent builds go first, regardless change order
    
    Returns:
    
    all (including cancelled and personal builds) for this build configuration, ordered according to orderByChanges parameter.
  - getHistory
```
public List<SFinishedBuild> getHistory(@Nullable
                                       User user,
                                       boolean includeCanceled,
                                       boolean orderByChanges)
```
    Description copied from interface: SBuildType
    
    Returns all finished builds, visible for the specified user of this configuration.
    
    Specified by:
    
    getHistory in interface SBuildType
    
    Parameters:
    
    user - specified user. If user is null no personal builds will be included into the list, otherwise there will be personal builds for the specified user.
    includeCanceled - if canceled builds should be included. orderByChanges - if true, builds are ordered by changes, i.e. most recent build with recent changes goes first; if false, most recent builds go first, regardless change order Returns: list of all finished builds sorted according to orderByChanges field.
  getLastChangesStartedBuild public SBuild getLastChangesStartedBuild() Description copied from interface: SBuildType Returns instance of the build, finished or running, which contains latest changes in this build configuration Specified by: getLastChangesStartedBuild in interface SBuildType Returns: build with latest changes getAgentCompatibilities public List<AgentCompatibility> getAgentCompatibilities() Description copied from interface: SBuildType Returns information about what agent are compatible with the configuration, what are incompatible and why. AgentCompatibility are provided for all authorized agents. Specified by: getAgentCompatibilities in interface SBuildType Returns: list of compatibility information holders. getAgentCompatibility public AgentCompatibility getAgentCompatibility(@NotNull SBuildAgent agent) Description copied from interface: SBuildType Returns information about agent compatibility for the specified agent. Specified by: getAgentCompatibility in interface SBuildType Parameters: agent - the given agent. Returns: agent compatibility for the specified agent. getAgentTypeCompatibility @NotNull public AgentCompatibility getAgentTypeCompatibility(@NotNull SAgentType agentType) Specified by: getAgentTypeCompatibility in interface BuildTypeEx getCanRunAndCompatibleAgentTypes public List<StartableAgentType> getCanRunAndCompatibleAgentTypes() Description copied from interface: BuildTypeEx Returns list of cloud agent types which are both allowed to run this configuration and are compatible with it. Specified by: getCanRunAndCompatibleAgentTypes in interface BuildTypeEx Returns: list of cloud agent types which are both allowed to run this configuration and are compatible with it. getDependencyGraph @NotNull public BuildTypeDependencyGraph getDependencyGraph() Specified by: getDependencyGraph in interface BuildTypeEx Returns: graph of snapshot dependencies assuming this build configuration is a top one. findTops @NotNull public Collection<BuildTypeEx> findTops() Specified by: findTops in interface BuildTypeEx Returns: all topmost build configurations having direct or transitive snapshot dependency on this build configuration. If there are no such build configurations returns itself. getAgentCompatibility @NotNull public CompatibilityResult getAgentCompatibility(@NotNull AgentDescription agentDescription) Description copied from interface: CompatibleAgents Fetches compatibility information for given agent description Specified by: getAgentCompatibility in interface CompatibleAgents Parameters: agentDescription - agent description Returns: compatibility results. See Also: CompatibilityResult getCompatibilityMap @NotNull public Map<SBuildAgent,CompatibilityResult> getCompatibilityMap() Description copied from interface: CompatibleAgents Returns compatibility map, key is an agent and value is compatibility result. Specified by: getCompatibilityMap in interface CompatibleAgents Returns: see above getCompatibleAgents @NotNull public Collection<SBuildAgent> getCompatibleAgents() Description copied from interface: CompatibleAgents Returns collection of compatible agents Specified by: getCompatibleAgents in interface CompatibleAgents Returns: see above processHistoryEntries public void processHistoryEntries(@NotNull ItemProcessor<SFinishedBuild> itemProcessor) Description copied from interface: BuildTypeEx Invokes the given ItemProcessor for all history records of this build type. Entries are pushed into the processor in changes order. Specified by: processHistoryEntries in interface BuildTypeEx Parameters: itemProcessor - processor for history entries getCanRunAgents public List<BuildAgentEx> getCanRunAgents() Description copied from interface: SBuildType Returns list of agents where this build configuration can run. Build configuration can run on an agent if this agent is authorized and if agent run policy BuildAgentManager.RunConfigurationPolicy allows to run this build configuration. Note that this method does not consider agent pool associations. Specified by: getCanRunAgents in interface SBuildType Returns: list of agents where this build configuration can run sorted by agent name getCanRunAndCompatibleAgents public List<BuildAgentEx> getCanRunAndCompatibleAgents(boolean includeDisabled) Description copied from interface: SBuildType Returns list of agents which are both allowed to run this configuration and are compatible with it. Specified by: getCanRunAndCompatibleAgents in interface SBuildType Parameters: includeDisabled - true to include disabled agents in the list, by default they are excluded Returns: list of agents which are both allowed to run this configuration and are compatible with it. getBuildNumbers public BuildNumbers getBuildNumbers() Description copied from interface: SBuildType Returns interface to manipulate current build counter Specified by: getBuildNumbers in interface SBuildType Returns: see above getRunningBuilds @NotNull public List<SRunningBuild> getRunningBuilds(@Nullable User user) Description copied from interface: SBuildType See BuildType.getRunningBuilds(User) Specified by: getRunningBuilds in interface BuildType Specified by: getRunningBuilds in interface SBuildType Parameters: user - owner of personal builds Returns: list of running builds getRunningBuilds @NotNull public List<SRunningBuild> getRunningBuilds() Description copied from interface: SBuildType Same as getRunningBuilds(null) Specified by: getRunningBuilds in interface BuildType Specified by: getRunningBuilds in interface SBuildType Returns: list of running builds getLastChangesFinished public SFinishedBuild getLastChangesFinished() Description copied from interface: BuildType Returns last finished instance for the build configuration with last user changes (personal builds and canceled builds are excluded). Specified by: getLastChangesFinished in interface BuildType Specified by: getLastChangesFinished in interface SBuildType Returns: last finished build (ordered by changes) from the default branch. getLastChangesSuccessfullyFinished public SFinishedBuild getLastChangesSuccessfullyFinished() Description copied from interface: BuildType Returns last successfully finished build in the configuration with last user changes, personal builds are not considered Specified by: getLastChangesSuccessfullyFinished in interface BuildType Specified by: getLastChangesSuccessfullyFinished in interface SBuildType Returns: last successfully finished build (ordered by changes) from the default branch. setPaused public void setPaused(boolean paused, User user) Description copied from interface: SBuildType Pause/unpause this build configuration. Paused build configuration is not triggered by VCS check-ins and time triggers. Specified by: setPaused in interface SBuildType Parameters: paused - if configuration should be paused user - use who is pausing the configuration setPaused public void setPaused(boolean paused, User user, String comment) Description copied from interface: SBuildType Pause/unpause this build configuration. Paused build configuration is not triggered by VCS check-ins and time triggers. Specified by: setPaused in interface SBuildType Parameters: paused - if configuration should be paused user - use who is pausing the configuration comment - user comment getPauseComment public Comment getPauseComment() Description copied from interface: SBuildType Returns comment for pausing/resuming this build type Specified by: getPauseComment in interface SBuildType Returns: comment for pausing/resuming this build type getLastPauseComment @Nullable public Comment getLastPauseComment() Description copied from interface: BuildTypeEx Differs from SBuildType.getPauseComment() - it returns last comment for pause action only. Specified by: getLastPauseComment in interface BuildTypeEx Returns: getSourceBuildType @NotNull public SBuildType getSourceBuildType() Description copied from interface: BuildTypeEx If current instance is an instance of RemoteBuildType - returns base configuration for remote build type, otherwise - returns this. Specified by: getSourceBuildType in interface BuildTypeEx Specified by: getSourceBuildType in interface LVcsRootInstanceHolderEx Returns: see below. getProject @NotNull public ProjectEx getProject() Description copied from interface: BuildTypeIdentity Returns the project this build type entity belongs to. Specified by: getProject in interface BuildTypeEx Specified by: getProject in interface BuildTypeIdentity Specified by: getProject in interface BuildTypeSettings Specified by: getProject in interface SBuildType Returns: the project this build type entity belongs to. newRunningBuild @NotNull public RunningBuildEx newRunningBuild(@NotNull QueuedBuildEx queuedBuild, @Nullable SBuildAgent buildAgent, @NotNull Date removeFromQueueTime) Description copied from interface: BuildTypeEx Creates new SRunningBuild instance. Specified by: newRunningBuild in interface BuildTypeEx Parameters: queuedBuild - source queued build buildAgent - agent the build will be running on or null if build is agent less removeFromQueueTime - time when build was removed from the queue Returns: the new running build newAgentLessBuild @NotNull public RunningBuildEx newAgentLessBuild(@NotNull QueuedBuildEx queuedBuild, @Nullable SBuildAgent buildAgent, @NotNull Date removeFromQueueTime) Description copied from interface: BuildTypeEx Creates new SRunningBuild instance and sets executor name as a build promotion attribute for the purposes of Executor mode builds. Specified by: newAgentLessBuild in interface BuildTypeEx Parameters: queuedBuild - source queued build buildAgent - agent the build will be running on or null if build is agent less removeFromQueueTime - time when build was removed from the queue Returns: the new running build attachedToModel public void attachedToModel(@NotNull ProjectDataModel model) Specified by: attachedToModel in interface BuildTypeEx createBuildPromotion @NotNull public BuildPromotionEx createBuildPromotion() Description copied from interface: BuildTypeEx Creates new build promotion which then can be used when build is added to a queue. Build promotion holds necessary information to reproduce a build. If build configuration has source dependencies on other build configurations, the whole graph is constructed and the top node of this graph (corresponding to this build configuration) is returned. Specified by: createBuildPromotion in interface BuildTypeEx Returns: newly created build promotion. createBuildPromotion @NotNull public BuildPromotionEx createBuildPromotion(@NotNull String branchName) Description copied from interface: BuildTypeEx Creates build promotion graph and sets specified branch name to all its nodes. Specified by: createBuildPromotion in interface BuildTypeEx Parameters: branchName - name of the branch Returns: newly created build promotion. createBuildPromotion @NotNull public BuildPromotionEx createBuildPromotion(@NotNull String branchName, @Nullable BuildPromotionInitializer initializer) Description copied from interface: BuildTypeEx Same as BuildTypeEx.createBuildPromotion(String) but accepts initializer which is called for every new build promotion in the created build chain Specified by: createBuildPromotion in interface BuildTypeEx Returns: createBuildPromotion public BuildPromotionEx createBuildPromotion(@Nullable String branchName, @Nullable BuildPromotionInitializer initializer, @Nullable DependenciesSupplier dependenciesSupplier) Description copied from interface: BuildTypeEx Same as BuildTypeEx.createBuildPromotion(String) but accepts initializer and dependencies supplier. Initializer is called for every new build promotion in the created build chain, while dependencies supplier is used to fetch dependencies of the current node while the build chain is constructed. Specified by: createBuildPromotion in interface BuildTypeEx Returns: createBuildCustomizer @NotNull public BuildCustomizer createBuildCustomizer(@Nullable SUser user) Description copied from interface: BuildTypeEx Creates BuildCustomizer that can be used to create custom promotions for this build type Specified by: createBuildCustomizer in interface BuildTypeEx createPersonalBuildType @NotNull public RemoteBuildTypeEx createPersonalBuildType(@NotNull User user, @Nullable String comment) Description copied from interface: BuildTypeEx Creates personal build type, i.e. build type which is used to start personal builds. Specified by: createPersonalBuildType in interface BuildTypeEx Parameters: user - personal build type owner comment - personal comment Returns: new personal build type createPersonalBuildType @NotNull public RemoteBuildTypeEx createPersonalBuildType(@NotNull User user, long changeListId) Description copied from interface: BuildTypeEx Creates personal build type, i.e. build type which is used to start personal builds. Specified by: createPersonalBuildType in interface BuildTypeEx Parameters: user - personal build type owner changeListId - id of the personal change list (must be published separately) Returns: new personal build type createPersonalBuildType @NotNull public RemoteBuildTypeEx createPersonalBuildType(@NotNull User user, @Nullable String comment, @NotNull Map<VcsRootInstance,VcsRootInstance> overridenRoots) Description copied from interface: BuildTypeEx Create personal build type that starts build with overriden roots. If there are snapshot dependencies, personal builds will be created for those nodes where overridden roots are applicable. Specified by: createPersonalBuildType in interface BuildTypeEx Parameters: user - personal build type owner comment - personal comment overridenRoots - overriden roots map (original root -> substitution root) Returns: new personal build type addToQueue public SQueuedBuild addToQueue(@NotNull BuildPromotionEx buildPromotion, @NotNull String triggeredBy) Description copied from interface: BuildTypeEx Adds build to queue with specified build promotion. Build promotion contains various settings necessary to run a build, like build parameters, build revisions and so on. Specified by: addToQueue in interface BuildTypeEx Parameters: buildPromotion - build promotion triggeredBy - who added build to queue Returns: new queued build instance if there is no instances of this configuration in the queue, or previously added instance otherwise. addToQueue public SQueuedBuild addToQueue(@NotNull SAgentRestrictor agentRestrictor, @NotNull BuildPromotionEx buildPromotion, @NotNull String triggeredBy) Description copied from interface: BuildTypeEx Adds build to queue on the specified agent with manually set build parameters: these build parameters will redefined build parameters specified within this build configuration Specified by: addToQueue in interface BuildTypeEx buildPromotion - build promotion triggeredBy - who added build to queue Returns: new queued build instance if there is no instances of this configuration in the queue, or previously added instance otherwise. getSettings @NotNull public BuildTypeSettingsEx getSettings() Specified by: getSettings in interface BuildTypeEx Specified by: getSettings in interface BuildTypeIdentityEx Returns: Underlying build settings object dispose public void dispose() Description copied from interface: BuildTypeEx Must be called when this build configuration object is removed from the model. Specified by: dispose in interface BuildTypeEx remove public void remove() Description copied from interface: SPersistentEntity Removes this entity. This method also makes all changes (related to removing the entity) on the disk and in the database. There is no need to call the persist() after this method. Specified by: remove in interface SPersistentEntity unregister public void unregister() Description copied from interface: BuildTypeEx Must be called when this build configuration was removed from the project completely (calls dispose too). Specified by: unregister in interface BuildTypeEx Specified by: unregister in interface BuildTypeIdentityEx setExternalId public void setExternalId(@NotNull ConfigAction configAction, @NotNull String newId, boolean sendEvents) throws InvalidIdentifierException, DuplicateExternalIdException, ObsoleteEntityException Description copied from interface: BuildTypeIdentityEx Same as {BuildTypeIdentity.setExternalId(ConfigAction, String)} but provides control over events processing. If parameter sendEvents is false, then no events about changing of the external id will be sent. This mode can be useful if the events will be sent later, for instance, in case of bulk edit ids operation. Specified by: setExternalId in interface BuildTypeIdentityEx Throws: InvalidIdentifierException DuplicateExternalIdException ObsoleteEntityException sendExtIdChangedEvents public void sendExtIdChangedEvents(@NotNull ConfigAction cause, @NotNull String oldExternalId, @NotNull String newExternalId) Description copied from interface: BuildTypeIdentityEx This method can be used to send external id changed event. Specified by: sendExtIdChangedEvents in interface BuildTypeIdentityEx isTemplateAccessible public boolean isTemplateAccessible() Description copied from interface: BuildTypeSettings Checks accessibility of all attached templates, excluding the default template (if present) Specified by: isTemplateAccessible in interface BuildTypeSettings Returns: true if there are such templates and all of them are accessible to currently logged in user, false otherwise replaceInValues public boolean replaceInValues(@NotNull Pattern regexpPattern, @NotNull String replacement) Description copied from interface: BuildTypeSettings Replaces values according to specified pattern and replacement string in all text parameters of the build configuration Specified by: replaceInValues in interface BuildTypeSettings Parameters: regexpPattern - regexp pattern replacement - replacement Returns: true if at least one text value was affected and false otherwise textValueMatches public boolean textValueMatches(@NotNull Pattern regexpPattern) Description copied from interface: BuildTypeSettings Returns true if configuration has value in text parameters which matches specified pattern. Only own parameters are checked - without inherited Specified by: textValueMatches in interface BuildTypeSettings Parameters: regexpPattern - regexp pattern Returns: true if such value exists and false otherwise setName public void setName(@NotNull String newName) throws DuplicateBuildTypeNameException, BuildTypeRenamingFailedException Description copied from interface: BuildTypeIdentity Sets name of this build type or template Specified by: setName in interface BuildTypeIdentity Specified by: setName in interface SBuildType Parameters: newName - the new name Throws: DuplicateBuildTypeNameException - if another build configuration with such name exists in the build configuration project BuildTypeRenamingFailedException - if build configuration renaming failed See Also: BuildTypeIdentity.getName(), BuildTypeIdentity.getFullName() setDescription public void setDescription(@Nullable String description) Description copied from interface: SBuildType Changes configuration description. Specified by: setDescription in interface SBuildType Parameters: description - new configuration description. getArtifactsReferences public List<SBuildType> getArtifactsReferences() Description copied from interface: SBuildType Returns list of build configurations which depend on this build configurations artifacts Specified by: getArtifactsReferences in interface SBuildType Returns: list of build configurations getNumberOfArtifactReferences public int getNumberOfArtifactReferences() Description copied from interface: SBuildType Returns number of dependent build configuration having references to this build configuration. This number may be greater than the size of the list SBuildType.getArtifactsReferences() because it takes into account all dependent build configurations while SBuildType.getArtifactsReferences() returns only build configurations accessible to an authority currently set in the security context. Specified by: getNumberOfArtifactReferences in interface SBuildType Returns: see above getArtifactsDirectory @NotNull public File getArtifactsDirectory() Description copied from interface: SBuildType Returns directory containing artifacts of this build configuration. Specified by: getArtifactsDirectory in interface SBuildType Returns: artifacts directory on the server. getPendingChanges public List<SVcsModification> getPendingChanges() Description copied from interface: SBuildType Returns changes in this build configuration already detected but not associated with a build. Only own changes are returned ignoring changes from dependencies option. Specified by: getPendingChanges in interface BuildType Specified by: getPendingChanges in interface SBuildType Returns: list of version control modifications, which are detected but no build with these modifications is created yet. getDetectedChanges @NotNull public List<ChangeDescriptor> getDetectedChanges(@NotNull SelectPrevBuildPolicy policy) Specified by: getDetectedChanges in interface BuildTypeEx getDetectedChanges @NotNull public List<ChangeDescriptor> getDetectedChanges(@NotNull SelectPrevBuildPolicy prevBuildPolicy, @Nullable Boolean includeDependencyChanges) Specified by: getDetectedChanges in interface BuildTypeEx getRawDependedOnMe @NotNull public Map<String,DependencyOptions> getRawDependedOnMe() Description copied from interface: BuildTypeEx Map from internal build type id to dependency options Specified by: getRawDependedOnMe in interface BuildTypeEx Returns: getDependedOnMe @NotNull public Map<SBuildType,DependencyOptions> getDependedOnMe() Specified by: getDependedOnMe in interface BuildTypeEx Returns: same as BuildTypeEx.getRawDependedOnMe() but with actual build types. getTransitiveDependedOnMe @NotNull public List<SBuildType> getTransitiveDependedOnMe() Description copied from interface: BuildTypeEx Returns all build configurations collected up the dependency chain. Note that returned dependencies are sorted by the distance from this build type. The returned list is filtered by current user permissions and may contain not all references. Specified by: getTransitiveDependedOnMe in interface BuildTypeEx traverseDependedOnMe public void traverseDependedOnMe(@NotNull DependencyConsumer<BuildTypeEx> consumer) Specified by: traverseDependedOnMe in interface BuildTypeEx traverseDependencies public void traverseDependencies(@NotNull DependencyConsumer<BuildTypeEx> consumer) Specified by: traverseDependencies in interface BuildTypeEx traverseSelfAndDependencies public void traverseSelfAndDependencies(@NotNull DependencyConsumer<BuildTypeEx> consumer) Specified by: traverseSelfAndDependencies in interface BuildTypeEx traverseSelfAndDependedOnMe public void traverseSelfAndDependedOnMe(@NotNull DependencyConsumer<BuildTypeEx> consumer) Specified by: traverseSelfAndDependedOnMe in interface BuildTypeEx getBranches @NotNull public List<BranchEx> getBranches(@NotNull BranchesPolicy policy, @Nullable Boolean includeBranchesFromDependencies) Specified by: getBranches in interface BuildTypeEx getBranches @NotNull public List<BranchEx> getBranches(@NotNull BranchesPolicy policy, @Nullable Boolean includeBranchesFromDependencies, boolean computeTimestamps) Specified by: getBranches in interface BuildTypeEx getBranches @NotNull public List<BranchEx> getBranches(@NotNull BranchCalculationOptions branchCalculationOptions) Specified by: getBranches in interface BuildTypeEx getBranch @NotNull public BranchEx getBranch(@NotNull String name) Specified by: getBranch in interface BuildTypeEx isValidVcsBranch public boolean isValidVcsBranch(@NotNull String name, boolean includeBranchesFromDependencies) Specified by: isValidVcsBranch in interface BuildTypeEx getOwnVcsBranchNames @NotNull public Collection<String> getOwnVcsBranchNames(boolean activeOnly) Specified by: getOwnVcsBranchNames in interface BuildTypeEx hasOwnBranches public boolean hasOwnBranches() Specified by: hasOwnBranches in interface BuildTypeEx getActiveBranches @NotNull public List<BranchEx> getActiveBranches() Specified by: getActiveBranches in interface BuildTypeEx getBuildTypeOrderedBuilds @NotNull public BuildTypeOrderedBuilds getBuildTypeOrderedBuilds() Specified by: getBuildTypeOrderedBuilds in interface BuildTypeEx getPendingChangesCommitters public Collection<SUser> getPendingChangesCommitters() Description copied from interface: SBuildType Returns pending changes committers to this build configuration Specified by: getPendingChangesCommitters in interface SBuildType Returns: see above getModificationsSinceLastSuccessful public List<SVcsModification> getModificationsSinceLastSuccessful() Description copied from interface: SBuildType Returns all modifications made since last successfully finished build Specified by: getModificationsSinceLastSuccessful in interface BuildType Specified by: getModificationsSinceLastSuccessful in interface SBuildType Returns: list of version control modifications, detected since last successful finished build has been finished getBranchSpec @NotNull public BranchSpec getBranchSpec(@NotNull LVcsRootInstance root) Specified by: getBranchSpec in interface LVcsRootInstanceHolderEx getBranchSpec @NotNull public BranchSpec getBranchSpec(@NotNull SVcsRoot root) Description copied from interface: BuildTypeEx Returns branch specification for specified parent root Specified by: getBranchSpec in interface BuildTypeEx Parameters: root - root of interest Returns: see above getLastUsedBranchSpecMap @NotNull public Map<VcsRootInstance,BranchSpec> getLastUsedBranchSpecMap() Specified by: getLastUsedBranchSpecMap in interface BuildTypeEx getLastUsedBranchSpecMap @NotNull public Map<VcsRootInstance,BranchSpec> getLastUsedBranchSpecMap(boolean includeSettingsRoot) Specified by: getLastUsedBranchSpecMap in interface BuildTypeEx getAdditionalBranchSpecs @NotNull public List<BranchSpec> getAdditionalBranchSpecs(@NotNull LVcsRootInstance root, @NotNull VcsRepositoryState state) Specified by: getAdditionalBranchSpecs in interface LVcsRootInstanceHolderEx getAdditionalBranchesForChangesCollecting @NotNull public Set<String> getAdditionalBranchesForChangesCollecting(@NotNull LVcsRootInstance root, @NotNull VcsRepositoryState state) Specified by: getAdditionalBranchesForChangesCollecting in interface LVcsRootInstanceHolderEx getBranchSpec @NotNull public BranchSpec getBranchSpec(@NotNull VcsRootInstance root) Specified by: getBranchSpec in interface BuildTypeEx getLastUsedBranchSpec @NotNull public BranchSpec getLastUsedBranchSpec(@NotNull SVcsRoot parentRoot) Description copied from interface: BuildTypeEx Returns branch specification used for changes collecting in given VCS root. If changes are not collected yet returns current value of branch specification. Specified by: getLastUsedBranchSpec in interface BuildTypeEx Parameters: parentRoot - root of interest Returns: see above rememberLastUsedRootInstanceAndBranchSpec public boolean rememberLastUsedRootInstanceAndBranchSpec(@NotNull LVcsRootInstance rootInst, @NotNull BranchSpec spec) Description copied from interface: LVcsRootInstanceHolderEx Stores branch specification used for changes collecting in given VCS root and resets a pending changes cache if root or spec is changed since last call to this method or when forcePendingChangesReset is true Specified by: rememberLastUsedRootInstanceAndBranchSpec in interface LVcsRootInstanceHolderEx spec - branch specification Returns: true if buildType's caches were updated branchesChanged public void branchesChanged(boolean currentNodeEvent, @NotNull Date branchChangeTimestamp) Description copied from interface: LVcsRootInstanceHolderEx Notifies build configuration that the branches may have changed. Specified by: branchesChanged in interface LVcsRootInstanceHolderEx branchChangeTimestamp - the time when the branches were changed (usually this is the time when we started collecting changes) getAdditionalBranchSpecs @NotNull public List<BranchSpec> getAdditionalBranchSpecs(@NotNull VcsRootInstance root, @NotNull VcsRepositoryState state) Specified by: getAdditionalBranchSpecs in interface BuildTypeEx isBranchSpecDefined public boolean isBranchSpecDefined(boolean processDependencies) Specified by: isBranchSpecDefined in interface BuildTypeEx Parameters: processDependencies - whether to process snapshot dependencies or not Returns: true if at least one vcs root in build configuration or its dependencies has VCS root with non empty branch spec isBranchSpecDefined public boolean isBranchSpecDefined(boolean processDependencies, boolean processSettingsRoot) Specified by: isBranchSpecDefined in interface BuildTypeEx clearPrevPromotionCache public void clearPrevPromotionCache(@Nullable Collection<BuildPromotion> targetPromos) Specified by: clearPrevPromotionCache in interface BuildTypeEx getBuildTriggerDescriptors @NotNull public Collection<BuildTriggerDescriptor> getBuildTriggerDescriptors(@NotNull String triggerName, boolean enabledOnly) Specified by: getBuildTriggerDescriptors in interface BuildTypeEx Parameters: triggerName - name of the trigger enabledOnly - whether to return only enabled triggers or all Returns: build triggers of specified type getResolvedBuildTriggerDescriptors @NotNull public Collection<BuildTriggerDescriptor> getResolvedBuildTriggerDescriptors(boolean enabledOnly) Specified by: getResolvedBuildTriggerDescriptors in interface BuildTypeEx Parameters: enabledOnly - whether to return only enabled triggers or all Returns: build triggers with resolved settings. getResolvedBuildTriggerDescriptors @NotNull public Collection<BuildTriggerDescriptor> getResolvedBuildTriggerDescriptors(@NotNull String triggerName, boolean enabledOnly) Specified by: getResolvedBuildTriggerDescriptors in interface BuildTypeEx Parameters: triggerName - name of the trigger enabledOnly - whether to return only enabled triggers or all Returns: build triggers of specified type with fully resolved settings. getPendingChangesInAllBranches @NotNull public List<ChangeDescriptor> getPendingChangesInAllBranches(@Nullable Boolean includeDependencyChanges) Description copied from interface: BuildTypeEx Returns pending changes detected in all branches of this build configuration. Specified by: getPendingChangesInAllBranches in interface BuildTypeEx Returns: list of pending changes. getPendingChangesInAllBranches @NotNull public List<ChangeDescriptor> getPendingChangesInAllBranches(@Nullable Boolean includeDependencyChanges, @NotNull VcsModificationProcessor callback) Specified by: getPendingChangesInAllBranches in interface BuildTypeEx getQueuedBuilds @NotNull public List<SQueuedBuild> getQueuedBuilds() Specified by: getQueuedBuilds in interface BuildTypeEx getLatestBuilds @NotNull public List<SBuild> getLatestBuilds() Specified by: getLatestBuilds in interface BuildTypeEx Returns: latest builds (currently running and last finished) getVcsSettingsHash @NotNull public String getVcsSettingsHash(@NotNull List<VcsRootInstanceEntry> vcsRootEntries) Description copied from interface: SBuildType Return name of the directory which should be used as checkout directory for this build configuration if explicit checkout directory is not specified. In fact, this name is a generated hash which depends on VCS Roots associated with this build configuration and some other settings, such as CheckoutType BuildTypeDescriptor.getCheckoutType() and checkout rules BuildTypeSettings.getCheckoutRules(jetbrains.buildServer.vcs.VcsRoot) Deprecated since 10.0, because for auto checkout mode this hash depends on effective checkout mode and is calculated on the agent. As a workaround, for auto checkout this method returns hash as if agent checkout is used. Specified by: getVcsSettingsHash in interface SBuildType Parameters: vcsRootEntries - vcs roots with checkout rules to get name hash for. Returns: name of the directory which will be used as last part of checkout directory See Also: BuildTypeSettings.setCheckoutDirectory(String) getVcsSettingsHash @NotNull public String getVcsSettingsHash() Description copied from interface: SBuildType Returns build configuration vcs settings hash. Note: be careful, when using this value for running build. Build type might already be updated Deprecated since 10.0, because for auto checkout mode this hash depends on effective checkout mode and is calculated on the agent. As a workaround, for auto checkout this method returns hash as if agent checkout is used. Specified by: getVcsSettingsHash in interface SBuildType Returns: see above getVcsRootsHash @NotNull public String getVcsRootsHash() Description copied from interface: SBuildType Returns build configuration vcs roots hash without taking checkout directory into account The resulting hash is an equal to the default checkout directory (since 10.0 it is true only for not auto checkout type). Note: be careful, when using this value for running build. Build type might already be updated Deprecated since 10.0, because for auto checkout mode this hash depends on effective checkout mode and is calculated on the agent. As a workaround, for auto checkout this method returns hash as if agent checkout is used. Specified by: getVcsRootsHash in interface SBuildType Returns: see above getVcsRootsHash @NotNull public String getVcsRootsHash(BuildTypeDescriptor.CheckoutType checkoutType) Description copied from interface: BuildTypeEx Returns build configuration vcs roots hash without taking checkout directory into account The resulting hash is an equal to the default checkout directory. Note: be careful, when using this value for running build. Build type might already be updated It's a replacement for deprecated SBuildType.getVcsRootsHash() - returns hash of vcs roots as if specified checkoutType is used. Don't accept BuildTypeDescriptor.CheckoutType.AUTO, throws IllegalArgumentException if passed. Specified by: getVcsRootsHash in interface BuildTypeEx releaseSources public void releaseSources() Description copied from interface: SBuildType Releases sources of the build configuration on ALL agents where this configuration built. After that full checkout will be performed when build of this configuration starts on such agents. Specified by: releaseSources in interface SBuildType releaseSources public void releaseSources(@NotNull SBuildAgent agent) Description copied from interface: SBuildType Releases sources of the build configuration on specified agent only. After that full checkout will be performed when build of this configuration starts on the specified agent. Specified by: releaseSources in interface SBuildType Parameters: agent - agent getAgentsWhereBuildConfigurationBuilt @NotNull public List<SBuildAgent> getAgentsWhereBuildConfigurationBuilt() Description copied from interface: SBuildType Returns list of agents (sorted by name) where this build configuration was ever built. Specified by: getAgentsWhereBuildConfigurationBuilt in interface SBuildType Returns: see above getTags public List<String> getTags() Description copied from interface: SBuildType List of all tags set for builds of this configuration. Specified by: getTags in interface SBuildType Returns: union of tags for each build for the configuration. forceCheckingForChanges public void forceCheckingForChanges() Description copied from interface: SBuildType Starts checking for changes for all VCS roots of this build configuration Specified by: forceCheckingForChanges in interface SBuildType forceCheckingForChanges public void forceCheckingForChanges(@NotNull OperationRequestor requestor) Description copied from interface: SBuildType Starts checking for changes for all VCS roots of this build configuration Specified by: forceCheckingForChanges in interface SBuildType addToQueue public SQueuedBuild addToQueue(@NotNull String triggeredBy) Description copied from interface: SBuildType Adds build instance of the configuration to the queue with the specified requestor name. Specified by: addToQueue in interface SBuildType Parameters: triggeredBy - contains details about who triggered build, see also TriggeredByBuilder Returns: new queued build instance if there is no instances of this configuration in the queue, or previously added instance otherwise. addToQueue public SQueuedBuild addToQueue(@NotNull BuildAgent agent, @NotNull String triggeredBy) Description copied from interface: SBuildType Adds build instance of the configuration to the queue with the specified requestor name on the specified agent (if agent is authorized). Specified by: addToQueue in interface SBuildType Parameters: agent - specified agent. triggeredBy - contains details about who triggered build, see also TriggeredByBuilder Returns: null if agent is not authorized, new SQueuedBuild instance if queue does not contain this configuration with specified agent and existing one otherwise getQueuedBuilds @NotNull public List<SQueuedBuild> getQueuedBuilds(@Nullable User user) Description copied from interface: SBuildType If user is null or has "Show personal builds of other users" enabled, returns all queued builds including all personal builds. Otherwise, returns non-personal queued builds and personal builds of the specified user. Specified by: getQueuedBuilds in interface SBuildType Parameters: user - user Returns: see above isCleanBuild public boolean isCleanBuild() Description copied from interface: SBuildType Returns if all files on an agent machine should be deleted before the build is started. Specified by: isCleanBuild in interface SBuildType Returns: true, if agent has to clean all sources and download all sources from the server before each build of the configuration. See Also: BuildTypeOptions.BT_CLEAN_BUILD isShouldFailBuildIfTestsFailed public boolean isShouldFailBuildIfTestsFailed() Description copied from interface: SBuildType Returns true if build of the configuration has to fail if there is failed test. Specified by: isShouldFailBuildIfTestsFailed in interface SBuildType Returns: true, if build has to became failed after at least one test failed, regardless of build script exit code. See Also: BuildTypeOptions.BT_FAIL_IF_TESTS_FAIL getExecutionTimeoutMin public int getExecutionTimeoutMin() Description copied from interface: SBuildType Returns duration the build allowed to run until killed by the server. Specified by: getExecutionTimeoutMin in interface SBuildType Returns: build execution timeout in minutes, timeout 0 means 'forever' See Also: BuildTypeOptions.BT_EXECUTION_TIMEOUT getId @NotNull public String getId() Description copied from interface: BuildConfigurationInfo Returns build configuration internal id Specified by: getId in interface BuildConfigurationInfo Returns: see above getMaximumNumberOfBuilds public int getMaximumNumberOfBuilds() Description copied from interface: SBuildType Returns maximum number of simultaneously running builds. 0 means there is no limit on a number of builds. Specified by: getMaximumNumberOfBuilds in interface BuildConfigurationInfo Specified by: getMaximumNumberOfBuilds in interface SBuildType Returns: see above See Also: BuildTypeOptions.BT_MAX_RUNNING_BUILDS getMaximumNumberOfBuildsPerBranch @NotNull public String getMaximumNumberOfBuildsPerBranch() Specified by: getMaximumNumberOfBuildsPerBranch in interface BuildTypeEx Returns: see BuildTypeOptions.BT_MAX_RUNNING_BUILDS_PER_BRANCH which may include parameters references or null if no limits specified getBuildDuration public long getBuildDuration(@NotNull BuildAgent agent) Description copied from interface: BuildConfigurationInfo Returns estimated duration of a build on the specified agent. Specified by: getBuildDuration in interface BuildConfigurationInfo Parameters: agent - build agent. Returns: Estimated time in milliseconds. -1 if an estimate cannot be calculated for some reason (e.g. lack of statistics). isAllowExternalStatus public boolean isAllowExternalStatus() Description copied from interface: SBuildType Returns if viewing of the configuration status is allowed externally. Specified by: isAllowExternalStatus in interface SBuildType Returns: if viewing of the configuration status is allowed externally. See Also: BuildTypeOptions.BT_ALLOW_EXTERNAL_STATUS getParametersProvider @NotNull public ParametersProvider getParametersProvider() Description copied from interface: ParametersSupport Returns parameters which can be used by value resolver. Note that some of the parameters may not have values defined because sometimes values can be calculated on the agent side only. Specified by: getParametersProvider in interface ParametersSupport Returns: parameters getValueResolver @NotNull public ValueResolver getValueResolver() Description copied from interface: ParametersSupport Returns value resolver which can be used to resolve references in values Specified by: getValueResolver in interface ParametersSupport Returns: value resolver moveToProject public void moveToProject(@NotNull SProject target, boolean changeScopeOfLocalRoots) Description copied from interface: SBuildType Moves this build configuration to the target project. Specified by: moveToProject in interface SBuildType Parameters: target - the destination project changeScopeOfLocalRoots - not used since 8.0 moveToProject public void moveToProject(@NotNull SProject target) throws InvalidVcsRootScopeException Description copied from interface: SBuildType Moves this build configuration to the target project. Specified by: moveToProject in interface SBuildType Parameters: target - the destination project Throws: InvalidVcsRootScopeException - if VCS roots used by this configuration will not be accessible in the target project moveToProject public void moveToProject(@NotNull ConfigAction cause, @NotNull SProject target) throws InvalidVcsRootScopeException Description copied from interface: SBuildType Moves this build configuration to the target project. Specified by: moveToProject in interface SBuildType Parameters: cause - config action caused the change target - the destination project Throws: InvalidVcsRootScopeException - if VCS roots used by this configuration will not be accessible in the target project mapVcsPath public PathMapping mapVcsPath(@NotNull String path) Description copied from interface: SBuildType Returns path mapping for the given full VCS path of a file if this path can correspond to any of the project's VCS roots. (TODO serganch: describe the term "full VCS path" somewhere) Specified by: mapVcsPath in interface SBuildType Specified by: mapVcsPath in interface VcsWorkspaceAccess Parameters: path - a full path to a file (not necessarily existing) Returns: the path mapping object or null if no mapping exists getExtendedName @NotNull public String getExtendedName() Description copied from interface: SBuildType Returns the name of build configuration with additional note if the project is archived. Useful when archived build configurations should be shown together with non-archived. Specified by: getExtendedName in interface SBuildType Returns: build configuration name See Also: SProject.getExtendedName() getExtendedFullName @NotNull public String getExtendedFullName() Description copied from interface: SBuildType Returns the full name of build configuration with additional note if the project is archived. Useful when archived build configurations should be shown together with non-archived. Specified by: getExtendedFullName in interface SBuildType Returns: build configuration name See Also: SProject.getExtendedFullName() getFileContent @NotNull public byte[] getFileContent(@NotNull String relativePath) throws VcsException Description copied from interface: SBuildType Get binary content of the latest version of a file related to this build type. Specified by: getFileContent in interface SBuildType Specified by: getFileContent in interface VcsWorkspaceAccess Parameters: relativePath - - relative file path regarding to the project root, "checkout root" from vcs root should not be included Returns: - specified file content, corresponding to the build type Throws: VcsException - if some problem occurred while getting file content from the source control repository. getFileContent @NotNull public byte[] getFileContent(@NotNull String relativePath, boolean latest) throws VcsException Description copied from interface: VcsWorkspaceAccess Same as {@link #getFileContent(String, false)} Specified by: getFileContent in interface VcsWorkspaceAccess Parameters: relativePath - relative file path regarding to the project root, "checkout root" from vcs root should not be included latest - if false, then file content corresponds to the revision detected during the last checking for changes process, if true, then the file content for the current repository revision will be returned Returns: binary content of the file Throws: VcsException - if some problem occurred while getting file content from the source control repository. getVcsFilesBrowser @NotNull public Browser getVcsFilesBrowser() Specified by: getVcsFilesBrowser in interface VcsWorkspaceAccess Returns: tree browser that shouws all contents VCS getVcsFoldersBrowser @NotNull public Browser getVcsFoldersBrowser() Specified by: getVcsFoldersBrowser in interface VcsWorkspaceAccess Returns: tree browser that shouws only directories in VCS attachToTemplate public void attachToTemplate(@NotNull BuildTypeTemplate template, boolean changeVcsRootsScope) Description copied from interface: SBuildType Attaches this build configuration to the specified template Specified by: attachToTemplate in interface SBuildType Parameters: template - template changeVcsRootsScope - if true then local non accessible VCS roots will be shared (not used since 8.0) addTemplate public void addTemplate(@NotNull BuildTypeTemplate template, boolean optimizeSettings) throws CannotAttachToTemplateException Description copied from interface: SBuildType Attach one more build configuration to a template. All previous templates will not be detached. If other templates are present in the build configuration, the newly attached templates will have the lowest priority, except for the default template (if configured in a corresponding project). Specified by: addTemplate in interface SBuildType Parameters: template - see above optimizeSettings - If true, the build configuration's owner settings will be optimised by eliminating duplication Throws: CannotAttachToTemplateException attachToTemplate public void attachToTemplate(@NotNull BuildTypeTemplate template) throws CannotAttachToTemplateException Description copied from interface: SBuildType Attaches this build configuration to the specified template. If the configuration is already template based, it will be detached from that template without copying of settings from it prior to being attached to the new template. Specified by: attachToTemplate in interface SBuildType Parameters: template - template Throws: CannotAttachToTemplateException - if template is not accessible from this build configuration setTemplatesOrder public void setTemplatesOrder(@NotNull List<String> templatesOrder) Description copied from interface: SBuildType Imposes new order on the templates the build configuration is attached to. Specified by: setTemplatesOrder in interface SBuildType Parameters: templatesOrder - the existing template ids in the new order. The list must match currently associated templates, excluding the default template. setTemplates public void setTemplates(@NotNull List<? extends BuildTypeTemplate> templates, boolean optimizeSettings) Description copied from interface: SBuildType Replaces templates the build configuration is attached to. No settings copying occurs for templates to which the configuration ceased to be attached to as a result. Specified by: setTemplates in interface SBuildType Parameters: templates - Ordered list of templates, the earlier a template in the list, the higher priority its settings have optimizeSettings - If true, the build configuration's owner settings will be optimised by eliminating duplication with the effective settings coming from the templates. getOwnTemplates public List<? extends BuildTypeTemplate> getOwnTemplates() Description copied from interface: SBuildType Returns a list of templates to which the build configuration is directly attached. That does not include default template. Specified by: getOwnTemplates in interface SBuildType Returns: see above detachFromTemplate public void detachFromTemplate() Description copied from interface: SBuildType Detaches build configuration from all templates, except for the default one if present. Effective template settings are copied to the build configuration itself. Specified by: detachFromTemplate in interface SBuildType removeTemplates public void removeTemplates(@NotNull Collection<? extends BuildTypeTemplate> templates, boolean inlineSettings) Description copied from interface: SBuildType Detaches build configuration from a number of templates. Specified by: removeTemplates in interface SBuildType Parameters: templates - a collection of templates, the configuration must be attached to these (and possible some other) templates inlineSettings - if true, the effective settings coming from these templates are copied to the build configuration inline @NotNull public BuildTypeEx inline() Description copied from interface: BuildTypeEx Creates a temporary copy of this buildType with all settings inherited from a project or a template inlined. Specified by: inline in interface BuildTypeEx persist public void persist() throws PersistFailedException Description copied from interface: SPersistentEntity Persists this entity instance onto disk. Should be called each time when settings are changed, otherwise the changes will be lost after the server restart. Specified by: persist in interface BuildTypeSettings Specified by: persist in interface SBuildType Specified by: persist in interface SPersistentEntity Throws: PersistFailedException - if persisting failed persist public void persist(@NotNull ConfigAction cause) throws PersistFailedException Description copied from interface: SPersistentEntity Persists this entity on disk. Specified by: persist in interface BuildTypeSettings Specified by: persist in interface SPersistentEntity Parameters: cause - an action which caused persisting Throws: PersistFailedException - if persisting failed schedulePersisting @NotNull public PersistTask schedulePersisting(@NotNull ConfigAction cause) throws PersistFailedException Description copied from interface: SPersistentEntity Schedules background persisting of this project settings. Specified by: schedulePersisting in interface SPersistentEntity Parameters: cause - an action which caused persisting Returns: a task which can be used to track the operation progress or wait for the operation to complete Throws: PersistFailedException - if failed to schedule the operation See Also: SPersistentEntity.schedulePersisting(String) schedulePersisting @NotNull public PersistTask schedulePersisting(@NotNull String reason) throws PersistFailedException Description copied from interface: SPersistentEntity Schedules background persisting of this entity settings. Specified by: schedulePersisting in interface SPersistentEntity Parameters: reason - provides a reason why persist operation was called Returns: a task which can be used to track the operation progress or wait for the operation to complete Throws: PersistFailedException - if failed to schedule the operation See Also: SPersistentEntity.schedulePersisting(ConfigAction) scheduleRemove @NotNull public PersistTask scheduleRemove(@NotNull ConfigAction cause) throws PersistFailedException Description copied from interface: SPersistentEntity Schedules remove of this persistent entity. Returns task which can be used to wait for the operation to complete. Specified by: scheduleRemove in interface SPersistentEntity Parameters: cause - reason of the remove Returns: a task which can be used to track the operation progress or wait for the operation to complete Throws: PersistFailedException - if failed to schedule the operation getResolvedSettings @NotNull public ResolvedSettings getResolvedSettings() Description copied from interface: SBuildType Returns resolved settings of this build configuration (with parameter references substituted) Specified by: getResolvedSettings in interface SBuildType Returns: see above getOwnDependencies @NotNull public List<Dependency> getOwnDependencies() Description copied from interface: SBuildType Returns list of own dependencies (not inherited from a template). Specified by: getOwnDependencies in interface SBuildType Returns: list of own dependencies getCustomDataStorage @NotNull public CustomDataStorage getCustomDataStorage(@NotNull String storageId) Description copied from interface: SBuildType Returns custom data storage associated with this build configuration. Custom data storage allows to attach custom data to a build configuration. Example of custom data is a state of some plugin associated with this build type (not configuration of the plugin). Custom data will be automatically cleaned when build configuration is removed. Specified by: getCustomDataStorage in interface SBuildType Parameters: storageId - - id of the storage. Custom data storageIds starting with "teamcity" are reserved for TeamCity internal usages. To reduce probability of identifiers clashing plugins can use fully qualified names of their classes or package names as storageId. Returns: custom data storage getRunnerTypes @NotNull public Collection<String> getRunnerTypes() Description copied from interface: BuildTypeDescriptor Returns collection of types of enabled build runners configured in this configuration Specified by: getRunnerTypes in interface BuildTypeDescriptor Specified by: getRunnerTypes in interface BuildTypeSettings Returns: see above isPersonal public boolean isPersonal() Description copied from interface: BuildTypeDescriptor Returns if the configuration is temporary created for the personal build. Specified by: isPersonal in interface BuildTypeDescriptor Returns: true if configuration was created to run some personal changes. Such sort of configurations are not available from an administrative interface, only for internal usage. getRequirements @NotNull public List<Requirement> getRequirements() Description copied from interface: BuildTypeSettings Get list of explicit requirements for build agents which can run this build configuration. Explicit requirements are specified by user in Web UI explicitly. Specified by: getRequirements in interface BuildTypeSettings Returns: see above addRequirement public void addRequirement(@NotNull Requirement requirement) Description copied from interface: BuildTypeSettings Adds new build requirement to the configuration. If the requirement has no id, then a copy of it with new id is generated and added to the settings. Specified by: addRequirement in interface BuildTypeSettings Parameters: requirement - new requirement. removeRequirement public void removeRequirement(String propertyName) Description copied from interface: BuildTypeSettings Removes first requirement with the specified property name from the configuration. Specified by: removeRequirement in interface BuildTypeSettings Parameters: propertyName - name of the requirement parameter. removeRequirement public void removeRequirement(Requirement requirement) Description copied from interface: BuildTypeSettings Removes a requirement from the configuration. Specified by: removeRequirement in interface BuildTypeSettings Parameters: requirement - requirement to be removed getBuildNumberPattern @NotNull public String getBuildNumberPattern() Description copied from interface: BuildTypeSettings Returns current build number pattern Specified by: getBuildNumberPattern in interface BuildTypeSettings Returns: see above setBuildNumberPattern public void setBuildNumberPattern(@NotNull String pattern) Description copied from interface: BuildTypeSettings Sets build number pattern. %build.counter% in the pattern will be replaced with current build number value when build starts Specified by: setBuildNumberPattern in interface BuildTypeSettings Parameters: pattern - pattern to set getBuildParameters @NotNull public Map<String,String> getBuildParameters() Description copied from interface: BuildType Returns the map of build parameters specified by user. For more details please see BuildTypeSettings.getBuildParameters() (server side). Specified by: getBuildParameters in interface BuildType Specified by: getBuildParameters in interface BuildTypeSettings Returns: build parameters map See Also: BuildType.getBuildParameter(String) getParameters @NotNull public Map<String,String> getParameters() Description copied from interface: BuildType Returns map of build and configuration parameters. Specified by: getParameters in interface BuildType Specified by: getParameters in interface InheritableUserParametersHolder Specified by: getParameters in interface ReadOnlyUserParameters Returns: build and configuration parameters map getParameterValue @Nullable public String getParameterValue(@NotNull String paramName) Specified by: getParameterValue in interface ReadOnlyUserParameters Parameters: paramName - parameter name Returns: value of the parameter with given name or null if there is no such parameter getOwnParametersCollection @NotNull public Collection<Parameter> getOwnParametersCollection() Specified by: getOwnParametersCollection in interface InheritableUserParametersHolder Returns: own parameters, without inherited. Yet they would have inherited specs or values (if any). getOwnParameters @NotNull public Map<String,String> getOwnParameters() Specified by: getOwnParameters in interface InheritableUserParametersHolder Returns: own parameters map, without inherited. Yet they would have inherited specs or values (if any). getBuildParametersCollection @NotNull public Collection<Parameter> getBuildParametersCollection() Description copied from interface: BuildTypeSettings Returns build parameters collection. Specified by: getBuildParametersCollection in interface BuildTypeSettings Returns: see above addBuildParameter public void addBuildParameter(Parameter parameter) Description copied from interface: BuildTypeSettings Adds build parameter to the configuration. Build parameter is a system or environment variable. Concrete parameter type is being selected by its name prefix. Constants.SYSTEM_PREFIX for system properties and Constants.ENV_PREFIX for environment variable. Specified by: addBuildParameter in interface BuildTypeSettings Parameters: parameter - specified parameter. removeBuildParameter public void removeBuildParameter(String paramName) Description copied from interface: BuildTypeSettings Removes existing build parameter by its name. Specified by: removeBuildParameter in interface BuildTypeSettings Parameters: paramName - specified parameter name. addRunParameter public void addRunParameter(@NotNull Parameter parameter) Description copied from interface: BuildTypeEx For tests only! Specified by: addRunParameter in interface BuildTypeEx getLogicalBranchNames @NotNull public Set<String> getLogicalBranchNames(@NotNull VcsRootInstance root, @NotNull String vcsBranch) Description copied from interface: BuildTypeEx Returns set of possible logical names for the given VCS branch in the given VCS root according to current VCS root settings (i.e. default branch, branch spec) Specified by: getLogicalBranchNames in interface BuildTypeEx Parameters: root - root of interest vcsBranch - vcs branch of interest Returns: see above or null if branch spec is not specified for this vcs root instance getDefaultBranchDisplayName @NotNull public String getDefaultBranchDisplayName() Description copied from interface: BuildTypeEx Returns a display name of the default branch according to the current settings of all VCS roots attached to build configuration (their default branch vcs names and branch specs). Returned value might be different from Branch.DEFAULT_BRANCH_NAME when logical name of the default branch in all the roots is the same. Specified by: getDefaultBranchDisplayName in interface BuildTypeEx Returns: see above getBranchByDisplayName @NotNull public BranchEx getBranchByDisplayName(@NotNull String branchDisplayName) Description copied from interface: BuildTypeEx Returns a branch by its display name. Usually branch display equals to branch name. The only exception is default branch (see comments to BuildTypeEx.getDefaultBranchDisplayName(). This method allows you to get a default branch by its custom display name. Use BuildTypeEx.getBranch(String) method if you are sure you use a branch name (not a display name) or branch is not a default one, because this method is slower than BuildTypeEx.getBranch(String). Specified by: getBranchByDisplayName in interface BuildTypeEx Parameters: branchDisplayName - branch display name Returns: see above hasBuilds public boolean hasBuilds() Specified by: hasBuilds in interface BuildTypeEx Returns: true if this build configuration has builds isInQueue public boolean isInQueue() Description copied from interface: BuildType Returns true if the configuration is queued at the moment Specified by: isInQueue in interface BuildType Returns: true if configuration is queued, false otherwise. getNumberQueued public int getNumberQueued() Description copied from interface: BuildType Returns number of items for this build configurations currently waiting in queue Specified by: getNumberQueued in interface BuildType Returns: number of queued builds of this configuration. getStatus public Status getStatus() Description copied from interface: BuildType Returns current status of the configuration. Specified by: getStatus in interface BuildType Returns: configuration status, which is calculated according to statuses of all the running builds (except personal) plus latest finished one. getStatusDescriptor @NotNull public BuildTypeStatusDescriptor getStatusDescriptor() Description copied from interface: BuildType Returns current status of the configuration with text description and status build. Specified by: getStatusDescriptor in interface BuildType Returns: configuration status, which is calculated according to statuses of all the running builds (except personal) plus latest finished one. getResponsibilityInfo @NotNull public ResponsibilityEntry getResponsibilityInfo() Description copied from interface: BuildType Returns the information about responsibility on this build configuration. Specified by: getResponsibilityInfo in interface BuildType Returns: ResponsibilityEntry information for this build configuration See Also: ResponsibilityEntry, BuildType.setResponsible(User, String, User), BuildType.removeResponsible(boolean, User, String, User) setResponsible public void setResponsible(@NotNull User responsibleUser, String userComment, User reporterUser) Description copied from interface: BuildType Called when a user takes a responsibility for the build type. Clients are encouraged to use BuildTypeResponsibilityFacade service when possible, as it provides more flexibility. Specified by: setResponsible in interface BuildType Parameters: responsibleUser - responsible user. Not null userComment - user message. Will be shown in UI reporterUser - user who performs the action. May be null for automated operations removeResponsible public void removeResponsible(boolean buildWasFixed, @Nullable User responsibleUser, String comment, User whoPerformsTheAction) Description copied from interface: BuildType Removes responsible information , mark it is either 'fixed' or 'not fixed'. Clients are encouraged to use BuildTypeResponsibilityFacade service when possible, as it provides more flexibility. Specified by: removeResponsible in interface BuildType Parameters: buildWasFixed - if true, build configuration will be marked as fixed responsibleUser - User who performs the action. May be null for automated operations comment - user message. Will be shown in UI whoPerformsTheAction - user who performs the action. May be null for automated operations getBuildByBuildNumber public Build getBuildByBuildNumber(@NotNull String buildNumber) Description copied from interface: BuildType Returns most recent build instance with specified build number. Generally, build number is unique but duplicates may happen if manually reset at build configuration page. Specified by: getBuildByBuildNumber in interface BuildType Parameters: buildNumber - specified build number. Returns: most recent build instance with the given number. getBuildParameter public String getBuildParameter(String key) Description copied from interface: BuildType Returns build parameter by parameter key Specified by: getBuildParameter in interface BuildType Specified by: getBuildParameter in interface BuildTypeSettings Parameters: key - parameter key Returns: build parameter by parameter key getVcsRoots @NotNull public List<SVcsRoot> getVcsRoots() Description copied from interface: BuildType Returns all roots currently attached to this configuration Specified by: getVcsRoots in interface BuildType Specified by: getVcsRoots in interface BuildTypeSettings Returns: collection of all attached vcs roots. addBuildTrigger public boolean addBuildTrigger(@NotNull BuildTriggerDescriptor triggerDescriptor) Description copied from interface: BuildTypeSettings Adds new trigger to build configuration settings. Use BuildTriggerDescriptorFactory to create trigger descriptor. Specified by: addBuildTrigger in interface BuildTypeSettings Parameters: triggerDescriptor - trigger descriptor Returns: true if trigger was added, and false if trigger with such id already exists addBuildTrigger @NotNull public BuildTriggerDescriptor addBuildTrigger(@NotNull String type, @NotNull Map<String,String> params) Description copied from interface: BuildTypeSettings Adds new trigger of specified type and with specified parameters to build configuration settings. Specified by: addBuildTrigger in interface BuildTypeSettings Parameters: type - type of the trigger params - parameters map Returns: newly created trigger descriptor removeBuildTrigger public boolean removeBuildTrigger(@NotNull BuildTriggerDescriptor triggerDescriptor) Description copied from interface: BuildTypeSettings Removes specified build trigger from the settings Specified by: removeBuildTrigger in interface BuildTypeSettings Parameters: triggerDescriptor - trigger descriptor Returns: true if trigger was actually removed and false otherwise updateBuildTrigger public boolean updateBuildTrigger(@NotNull String triggerId, @NotNull String newType, @NotNull Map<String,String> newParams) Description copied from interface: BuildTypeSettings Updates build trigger descriptor with specified id, changes type and parameters. Specified by: updateBuildTrigger in interface BuildTypeSettings Parameters: triggerId - id of build trigger descriptor newType - type of build trigger descriptor newParams - parameters map Returns: true if parameters of build trigger descriptor were changed (descriptor with such id exists) and false otherwise updateBuildTrigger public boolean updateBuildTrigger(@NotNull BuildTriggerDescriptor newDescriptor) Description copied from interface: BuildTypeSettings Updates build trigger descriptor with id equal to newDescriptor id. Specified by: updateBuildTrigger in interface BuildTypeSettings Parameters: newDescriptor - new settings of the trigger Returns: true if parameters of build trigger descriptor were changed (descriptor with such id exists) and false otherwise getBuildTriggersCollection @NotNull public Collection<BuildTriggerDescriptor> getBuildTriggersCollection() Description copied from interface: BuildTypeSettings Returns collection of build trigger settings Specified by: getBuildTriggersCollection in interface BuildTypeSettings Specified by: getBuildTriggersCollection in interface ResolvedSettings Returns: see above findTriggerById public BuildTriggerDescriptor findTriggerById(@NotNull String triggerId) Description copied from interface: BuildTypeSettings Finds build trigger descriptor by its' id Specified by: findTriggerById in interface BuildTypeSettings Parameters: triggerId - id of the trigger Returns: build trigger descriptor or null if trigger with such id not found setCheckoutType public void setCheckoutType(BuildTypeDescriptor.CheckoutType type) Description copied from interface: BuildTypeSettings Sets preferred checkout type for the configuration sources. Actual checkout type may differ, for example, if preferred checkout type is set to ON_AGENT, but there is vcs root which does not support on agent checkout, actual checkout type will be switched to ON_SERVER. BuildTypeDescriptor.CheckoutType.ON_SERVER - checkout sources automatically on the server and snd it to the agent. BuildTypeDescriptor.CheckoutType.ON_AGENT - checkout sources automatically on the agent. BuildTypeDescriptor.CheckoutType.MANUAL - do not check out sources automatically. Specified by: setCheckoutType in interface BuildTypeSettings Parameters: type - new checkout type. getCheckoutType @NotNull public BuildTypeDescriptor.CheckoutType getCheckoutType() Description copied from interface: BuildTypeDescriptor Returns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself. Specified by: getCheckoutType in interface BuildTypeDescriptor Specified by: getCheckoutType in interface BuildTypeSettings Returns: method to get sources on agent. isPaused public boolean isPaused() Description copied from interface: BuildTypeDescriptor Returns if the configuration is paused. Specified by: isPaused in interface BuildTypeDescriptor Returns: true is build is paused. In this state build can be added to queue manually only, all other triggers are disabled. getProjectId @NotNull public String getProjectId() Description copied from interface: BuildTypeDescriptor Returns internal id of the project this build configuration configured in. Specified by: getProjectId in interface BuildTypeDescriptor Returns: parent project internal id. getProjectExternalId @NotNull public String getProjectExternalId() Description copied from interface: BuildTypeDescriptor Returns external id of the project this build configuration configured in. Specified by: getProjectExternalId in interface BuildTypeDescriptor Returns: parent project external id. setCheckoutDirectory public void setCheckoutDirectory(@Nullable String dir) Description copied from interface: BuildTypeSettings Sets build checkout directory. Set it to null to use default checkout directory. Specified by: setCheckoutDirectory in interface BuildTypeSettings Parameters: dir - checkout directory getCheckoutDirectory @Nullable public String getCheckoutDirectory() Description copied from interface: BuildTypeSettings Returns build checkout directory - if specified explicitly using BuildTypeSettings.setCheckoutDirectory(String). Returns null if default checkout directory, generated by TeamCity should be used. Specified by: getCheckoutDirectory in interface BuildTypeSettings Specified by: getCheckoutDirectory in interface ResolvedSettings Returns: build checkout directory. See Also: BuildTypeSettings.setCheckoutDirectory(String) setArtifactPaths public void setArtifactPaths(@Nullable String artifactPaths) Description copied from interface: BuildTypeSettings Sets build artifact paths. Artifact paths are comma separated paths to build artifacts. Support ant-style wildcards and target directories like *.zip => winFiles,unix/dist.tgz => linuxFiles, where winFiles and linuxFiles are target directories. Set to null or empty string to disable artifacts processing. Specified by: setArtifactPaths in interface BuildTypeSettings Parameters: artifactPaths - paths to build artifacts getArtifactPaths @Nullable public String getArtifactPaths() Description copied from interface: BuildTypeSettings Returns build artifact paths. Specified by: getArtifactPaths in interface BuildTypeSettings Returns: build artifact paths getArtifactDependencies @NotNull public List<SArtifactDependency> getArtifactDependencies() Description copied from interface: BuildTypeSettings Returns artifacts this build configuration depending on. Specified by: getArtifactDependencies in interface BuildTypeSettings Returns: list of artifacts this build configuration depending on setArtifactDependencies public void setArtifactDependencies(@NotNull List<SArtifactDependency> artifacts) Description copied from interface: BuildTypeSettings Sets artifacts this build configuration depending on. Specified by: setArtifactDependencies in interface BuildTypeSettings Parameters: artifacts - new artifacts dependency list. addArtifactDependency public void addArtifactDependency(@NotNull SArtifactDependency dependency) Description copied from interface: BuildTypeSettings Adds artifact dependency. Specified by: addArtifactDependency in interface BuildTypeSettings Parameters: dependency - new artifact dependency removeArtifactDependency public void removeArtifactDependency(@NotNull SArtifactDependency dependency) Description copied from interface: BuildTypeSettings Removes artifact dependency. Specified by: removeArtifactDependency in interface BuildTypeSettings Parameters: dependency - artifact dependency containsVcsRoot public boolean containsVcsRoot(long vcsRootId) Description copied from interface: BuildTypeSettings Returns true if VCS root with specified id is attached directly or is inherited via a template Specified by: containsVcsRoot in interface BuildTypeSettings Parameters: vcsRootId - id of VCS root Returns: see above getVcsRootEntries @NotNull public List<VcsRootEntry> getVcsRootEntries() Description copied from interface: BuildTypeSettings Returns all entries of vcs roots. Each entry contains reference to root and its checkout rules. Specified by: getVcsRootEntries in interface BuildTypeSettings Returns: all entries of vcs roots for this configuration addVcsRoot public boolean addVcsRoot(@NotNull SVcsRoot root) throws InvalidVcsRootScopeException, VcsRootNotFoundException Description copied from interface: BuildTypeSettings Adds VCS root to the build configuration with default checkout rules. Specified by: addVcsRoot in interface BuildTypeSettings Parameters: root - VCS root to add Returns: true if VCS root was actually added and false otherwise (this VCS root already exists) Throws: InvalidVcsRootScopeException - if VCS root scope is local and corresponds to another project (not the project - owner of this build configuration) VcsRootNotFoundException - if specified VCS root does not exist anymore removeVcsRoot public boolean removeVcsRoot(@NotNull SVcsRoot root) Description copied from interface: BuildTypeSettings Removes existing VCS root from the build configuration. If there were checkout rules attached to this VCS root they will be removed too. Specified by: removeVcsRoot in interface BuildTypeSettings Parameters: root - VCS root to remove Returns: true if VCS root was actually removed from the build configuration and false if build configuration did not have this vcs root attached replaceVcsRoot public boolean replaceVcsRoot(@NotNull SVcsRoot oldVcsRoot, @NotNull SVcsRoot newVcsRoot) Description copied from interface: BuildTypeEx Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entries Specified by: replaceVcsRoot in interface BuildTypeEx Parameters: oldVcsRoot - VCS root to be replaced newVcsRoot - VCS root to insert instead Returns: true if VCS root was actually replaced, false otherwise (the root to be replaced did not exist or the new root already existed) setVcsRoots public boolean setVcsRoots(@NotNull Collection<SVcsRoot> vcsRoots) Description copied from interface: BuildTypeEx Sets VCS roots. All existing VCS roots that are not present in vcsRoots are deleted, all other existing VCS roots are reordered if necessary, but retain their original checkout rules. Specified by: setVcsRoots in interface BuildTypeEx Returns: true if any changes occurred setEditable public void setEditable(boolean editable) Description copied from interface: BuildTypeEx Enables or disables editing of the build type in web UI, see also SPersistentEntity.isReadOnly(). SBuildType.persist() method must be called afterwards. Specified by: setEditable in interface BuildTypeEx Parameters: editable - true to enable editing and false to disable setCheckoutRules public boolean setCheckoutRules(@NotNull VcsRoot root, @NotNull CheckoutRules checkoutRules) Description copied from interface: BuildTypeSettings Sets checkout rules for specified VCS root. VCS root must be attached to this build configuration. Specified by: setCheckoutRules in interface BuildTypeSettings Parameters: root - root to set rules for checkoutRules - checkout rules for the VCS root Returns: true if checkout rules were set for the VCS root (if VCS root is attached) and false otherwise getCheckoutRules public CheckoutRules getCheckoutRules(@NotNull VcsRoot root) Description copied from interface: BuildTypeSettings Returns checkout rules configured for the specified VCS root. If specified VCS root is not attached to this build configuration, then null is returned. Specified by: getCheckoutRules in interface BuildTypeSettings Specified by: getCheckoutRules in interface ResolvedSettings Parameters: root - VCS root Returns: checkout rules or null if specified VCS root is not attached to the build configuration getLabelingType @NotNull public VcsLabelingSettings.LabelingType getLabelingType() Specified by: getLabelingType in interface VcsLabelingSettings Returns: Returns labeling mode getLabelPattern @NotNull public String getLabelPattern() Specified by: getLabelPattern in interface VcsLabelingSettings Returns: Returns pattern to use for labeling getLabelingRoots @NotNull public List<VcsRoot> getLabelingRoots() Description copied from interface: VcsLabelingSettings List of roots which should be processed by labeling process Specified by: getLabelingRoots in interface VcsLabelingSettings Returns: list of up-to-date vcs roots addConfigParameter public void addConfigParameter(@NotNull Parameter param) Description copied from interface: BuildTypeSettings Adds configuration parameter. There are three different types of parameters which can be added to build configuration settings: build parameters - these are parameters passed to agent and then to a build (see BuildTypeSettings.addBuildParameter(Parameter)), these parameters must have prefix system. or env. runner parameters - these are parameters of a runner, they are transferred to agent and passed to corresponding build runner plugin configuration parameters - these parameters are not transferred to agent or build, but can be referenced in various places (including build & runner parameters and thus can effectively pass to a build) Specified by: addConfigParameter in interface BuildTypeSettings Parameters: param - configuration parameter removeConfigParameter public void removeConfigParameter(@NotNull String paramName) Description copied from interface: BuildTypeSettings Removes configuration parameters with specified name Specified by: removeConfigParameter in interface BuildTypeSettings Parameters: paramName - parameter name addParameter public void addParameter(@NotNull Parameter param) Description copied from interface: UserParametersHolder Adds parameter. Specified by: addParameter in interface UserParametersHolder Parameters: param - build or config parameter, the type is determined by parameter prefix removeParameter public void removeParameter(@NotNull String paramName) Description copied from interface: UserParametersHolder Removes parameter. Specified by: removeParameter in interface UserParametersHolder Parameters: paramName - build or config parameter name, the type is determined by parameter prefix getParametersCollection @NotNull public Collection<Parameter> getParametersCollection() Description copied from interface: ReadOnlyUserParameters Returns build and configuration parameters in single collection. Specified by: getParametersCollection in interface InheritableUserParametersHolder Specified by: getParametersCollection in interface ReadOnlyUserParameters Returns: merged collection of parameters, i.e. all parameters inherited from parent holders and own parameters getParameter @Nullable public Parameter getParameter(@NotNull String paramName) Specified by: getParameter in interface ReadOnlyUserParameters getConfigParametersCollection @NotNull public Collection<Parameter> getConfigParametersCollection() Description copied from interface: BuildTypeSettings Returns collection of configuration parameters. Specified by: getConfigParametersCollection in interface BuildTypeSettings Returns: see above getConfigParameters @NotNull public Map<String,String> getConfigParameters() Description copied from interface: BuildTypeSettings Returns map of configuration parameters Specified by: getConfigParameters in interface BuildTypeSettings Returns: see above getUndefinedParameters @NotNull public List<String> getUndefinedParameters() Description copied from interface: BuildTypeSettings Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided. I.e. there is a reference to a parameter but such parameter is not defined anywhere. Parameter value can come from different sources: build configuration or template settings agents various extensions Specified by: getUndefinedParameters in interface BuildTypeSettings Returns: see above getRunTypeRequirements @NotNull public List<Requirement> getRunTypeRequirements() Description copied from interface: BuildTypeSettings Returns list of additional agent requirements imposed by configured runners. Specified by: getRunTypeRequirements in interface BuildTypeSettings Returns: see above getBuildFeatureRequirements @NotNull public List<Requirement> getBuildFeatureRequirements() Description copied from interface: BuildTypeSettings Returns list of additional agent requirements imposed by configured enabled build features. Specified by: getBuildFeatureRequirements in interface BuildTypeSettings Returns: see above addBuildRunner @NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull BuildRunnerDescriptor runner) Description copied from interface: BuildTypeSettings Adds runner descriptor. Use BuildRunnerDescriptorFactory to create instance of runner descriptor. Before 8.0 this method required SBuildRunnerDescriptor as parameter Specified by: addBuildRunner in interface BuildTypeSettings Parameters: runner - descriptor Returns: instance of actually added runner addBuildRunner @NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull String name, @NotNull String runnerType, @NotNull Map<String,String> parameters) Description copied from interface: BuildTypeSettings Creates new build runner and adds it to these settings. Runner's ID is autogenerated Specified by: addBuildRunner in interface BuildTypeSettings Parameters: name - runner name runnerType - type of the runner parameters - runner parameters Returns: newly created runner addBuildRunner @NotNull public SBuildRunnerDescriptor addBuildRunner(@NotNull String id, @NotNull String name, @NotNull String runnerType, @NotNull Map<String,String> parameters) throws DuplicateIdException, InvalidIdentifierException, ReadOnlyEntityException Description copied from interface: BuildTypeSettings Creates a new build runner with the specified id, name, runner type, and parameters, and adds it to the current build settings. Specified by: addBuildRunner in interface BuildTypeSettings Parameters: id - the unique id of the build runner (should be unique within all runners of this configuration) name - the name of the build runner runnerType - the type of the build runner parameters - the parameters for the build runner Returns: the newly created build runner descriptor Throws: DuplicateIdException - if the id is already in use by another build runner, runners inherited from templates are not considered InvalidIdentifierException - if the id is invalid or empty ReadOnlyEntityException - if the settings are read-only and cannot be modified removeBuildRunner public SBuildRunnerDescriptor removeBuildRunner(@NotNull String runnerId) Description copied from interface: BuildTypeSettings Removes runner descriptor with specified id. Specified by: removeBuildRunner in interface BuildTypeSettings Parameters: runnerId - descriptor id Returns: removed runner descriptor updateBuildRunner public boolean updateBuildRunner(@NotNull String runnerId, @NotNull String name, @NotNull String type, @NotNull Map<String,String> params) Description copied from interface: BuildTypeSettings Updates parameters in the existing build runner descriptor. Does nothing if there runner with specified id was not found. Specified by: updateBuildRunner in interface BuildTypeSettings Parameters: runnerId - id of runner descriptor name - new runner name type - new type of the runner params - new runner parameters Returns: true if parameters updated and false otherwise getBuildRunners @NotNull public List<SBuildRunnerDescriptor> getBuildRunners() Description copied from interface: BuildTypeSettings Returns collection of build runners attached to these settings Specified by: getBuildRunners in interface BuildTypeSettings Specified by: getBuildRunners in interface ResolvedSettings Returns: see above findBuildRunnerByType @Nullable public SBuildRunnerDescriptor findBuildRunnerByType(@NotNull String runnerType) Description copied from interface: SBuildType Returns first build runner of specified type or null Specified by: findBuildRunnerByType in interface BuildType Specified by: findBuildRunnerByType in interface BuildTypeSettings Specified by: findBuildRunnerByType in interface SBuildType Parameters: runnerType - type of the runner Returns: see above findBuildRunnerById public SBuildRunnerDescriptor findBuildRunnerById(@NotNull String runnerId) Description copied from interface: BuildTypeSettings Finds build runner by its' id Specified by: findBuildRunnerById in interface BuildTypeSettings Parameters: runnerId - id of the runner Returns: build runner or null if runner with such id not found findRunnerParameter public String findRunnerParameter(@NotNull String paramName) Description copied from interface: BuildTypeSettings Searches runner parameter in all build runners and returns value of the first found parameter with given name. Specified by: findRunnerParameter in interface BuildTypeSettings Parameters: paramName - name of the parameter Returns: the first found parameter value or null getRunnerConditions @NotNull public BuildStepConditions getRunnerConditions(@NotNull SBuildRunnerDescriptor descriptor) Specified by: getRunnerConditions in interface BuildTypeSettings Returns: support for conditions for conditional build steps isTemplateBased public boolean isTemplateBased() Description copied from interface: BuildTypeSettings Returns true if these settings are directly based on a template. It does not take into account a default template. Specified by: isTemplateBased in interface BuildTypeSettings Returns: see above setOption public <T> void setOption(@NotNull Option<T> option, @NotNull T value) Description copied from interface: OptionSupport Set option value, clears value if it is the same as default Specified by: setOption in interface OptionSupport Parameters: option - option to set value for value - option value getOwnOptions @NotNull public Collection<Option> getOwnOptions() Description copied from interface: OptionSupport Return options defined in this object, i.e. options for which some value has been set using OptionSupport.setOption(Option, Object) method. Specified by: getOwnOptions in interface OptionSupport Returns: see above getOptions @NotNull public Collection<Option> getOptions() Specified by: getOptions in interface OptionSupport Returns: combined set of options - own and inherited getChangedOptions @NotNull public Option[] getChangedOptions() Description copied from interface: OptionSupport Return options with changed values, i.e. options with non-default values Specified by: getChangedOptions in interface OptionSupport Returns: see above getOption @NotNull public <T> T getOption(@NotNull Option<T> option) Description copied from interface: OptionSupport Get option value Specified by: getOption in interface OptionSupport Parameters: option - option to retrieve value for Returns: value of the option. If value wasn't set, Option:getDefaultValue is returned getOptionDefaultValue @NotNull public <T> T getOptionDefaultValue(@NotNull Option<T> option) Specified by: getOptionDefaultValue in interface OptionSupport Parameters: option - option whose default value to return Returns: default value for specified option getDependencies @NotNull public List<Dependency> getDependencies() Description copied from interface: DependencySettings Get existing dependencies, empty collection when no dependencies exist Specified by: getDependencies in interface DependencySettings Returns: see above addDependency public void addDependency(@NotNull Dependency dependOn) throws CyclicDependencyFoundException Description copied from interface: DependencySettings Add dependency on another build configuration Specified by: addDependency in interface DependencySettings Parameters: dependOn - new dependency Throws: CyclicDependencyFoundException - if cycle is detected removeDependency public boolean removeDependency(@NotNull Dependency dependOn) Description copied from interface: DependencySettings Remove dependency on another build configuration Specified by: removeDependency in interface DependencySettings Parameters: dependOn - dependency to remove Returns: true if dependency was actually removed getCleanupPolicies @NotNull public Collection<HistoryRetentionPolicy> getCleanupPolicies() Specified by: getCleanupPolicies in interface CleanupSettings Returns: combined cleanup policies, including those inherited from default or parent object getOwnCleanupPolicies @NotNull public Collection<HistoryRetentionPolicy> getOwnCleanupPolicies() Specified by: getOwnCleanupPolicies in interface CleanupSettings Returns: cleanup policies, specific for this object only getInheritedCleanupPolicies @NotNull public Collection<HistoryRetentionPolicy> getInheritedCleanupPolicies() Specified by: getInheritedCleanupPolicies in interface CleanupSettings getInheritedCleanupOptions @NotNull public Map<String,Boolean> getInheritedCleanupOptions() Specified by: getInheritedCleanupOptions in interface CleanupSettings getCleanupOptions @NotNull public Map<String,Boolean> getCleanupOptions() Specified by: getCleanupOptions in interface CleanupSettings Returns: map of all cleanup options getOwnCleanupOptions @NotNull public Map<String,Boolean> getOwnCleanupOptions() Specified by: getOwnCleanupOptions in interface CleanupSettings Returns: map of own cleanup options only addCleanupPolicy public void addCleanupPolicy(@NotNull HistoryRetentionPolicy policy) Description copied from interface: CleanupSettingsInit Sets cleanup policy for this build configuration Specified by: addCleanupPolicy in interface CleanupSettingsInit Parameters: policy - policy to set removeCleanupPolicies public void removeCleanupPolicies() Description copied from interface: CleanupSettingsInit Remove all own cleanup policies for the object Specified by: removeCleanupPolicies in interface CleanupSettingsInit setCleanupOption public void setCleanupOption(@NotNull String option, @Nullable Boolean value) Description copied from interface: CleanupSettingsInit Sets value for a cleanup option Specified by: setCleanupOption in interface CleanupSettingsInit Parameters: option - cleanup option (see CleanupSettings constants) value - value to set option to, or null to remove the option getTemplate public BuildTypeTemplate getTemplate() Description copied from interface: BuildTypeSettings Returns the first template these settings are based on. Specified by: getTemplate in interface BuildTypeSettings Returns: see above getTemplates @NotNull public List<? extends BuildTypeTemplate> getTemplates() Description copied from interface: BuildTypeSettings Returns templates these settings are based on, including the default template. Specified by: getTemplates in interface BuildTypeSettings Returns: see above getTemplateIds @NotNull public List<String> getTemplateIds() Description copied from interface: BuildTypeSettings Returns internal ids of the templates this settings are based on, including one of the default template Specified by: getTemplateIds in interface BuildTypeSettings Returns: see above getTemplateId public String getTemplateId() Description copied from interface: BuildTypeSettings Returns internal id of the first template this setting is based on Specified by: getTemplateId in interface BuildTypeSettings Returns: see above getDependencyReferences @NotNull public List<SBuildType> getDependencyReferences() Description copied from interface: SBuildType Returns list of build configurations directly referencing this build configuration. The returned list is filtered by current user permissions and may contain not all references. Specified by: getDependencyReferences in interface SBuildType Returns: see above getChildDependencies @NotNull public Collection<SBuildType> getChildDependencies() Description copied from interface: Dependent Returns all child dependencies collected down the chain. Note that returned dependencies are sorted by depth in the chain. Note that returned collection will contain accessible by current authority holder objects only. Specified by: getChildDependencies in interface Dependent Returns: see above getNumberOfDependencyReferences public int getNumberOfDependencyReferences() Description copied from interface: SBuildType Returns number of dependency references (the number includes all references even those which are not available because of permissions) Specified by: getNumberOfDependencyReferences in interface SBuildType Returns: see above isReadOnly public boolean isReadOnly() Specified by: isReadOnly in interface BuildTypeSettings Specified by: isReadOnly in interface SPersistentEntity Returns: true if this entity settings are in read only mode getReadOnlyReason @Nullable public ReadOnlyReason getReadOnlyReason() Specified by: getReadOnlyReason in interface BuildTypeSettings Specified by: getReadOnlyReason in interface SPersistentEntity Returns: reason why this entity settings are in read only state or null if they are not read only replaceInValues public boolean replaceInValues(@NotNull String regexp, @NotNull String replacement) throws PatternSyntaxException Description copied from interface: BuildTypeSettings Replaces values according to specified regexp and replacement string in all text parameters of the build configuration Specified by: replaceInValues in interface BuildTypeSettings Parameters: regexp - regexp replacement - replacement Returns: true if at least one text value was affected and false otherwise Throws: PatternSyntaxException - if pattern is incorrect addBuildFeature @NotNull public SBuildFeatureDescriptor addBuildFeature(@NotNull String type, @NotNull Map<String,String> params) Description copied from interface: BuildTypeSettings Adds build feature with specified type and parameters to this settings object. Specified by: addBuildFeature in interface BuildTypeSettings Parameters: type - build feature type params - build feature parameters Returns: build feature descriptor addBuildFeature public void addBuildFeature(@NotNull SBuildFeatureDescriptor feature) Description copied from interface: BuildTypeSettings Adds build feature descriptor to this settings object. Specified by: addBuildFeature in interface BuildTypeSettings Parameters: feature - build feature descriptor getBuildFeatures @NotNull public Collection<SBuildFeatureDescriptor> getBuildFeatures() Description copied from interface: BuildTypeSettings Returns build features added to this settings object. Specified by: getBuildFeatures in interface BuildTypeSettings Specified by: getBuildFeatures in interface ResolvedSettings Returns: collection of configured build features getBuildFeaturesOfType @NotNull public Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull String featureType) Description copied from interface: BuildTypeSettings Returns all build features of specified type. Specified by: getBuildFeaturesOfType in interface BuildTypeSettings Specified by: getBuildFeaturesOfType in interface ResolvedSettings Parameters: featureType - type of the build feature Returns: see above removeBuildFeature public SBuildFeatureDescriptor removeBuildFeature(@NotNull String featureId) Description copied from interface: BuildTypeSettings Removes build feature with specified id from this settings object. Specified by: removeBuildFeature in interface BuildTypeSettings Parameters: featureId - id of the feature Returns: removed build feature descriptor or null if there were no feature descriptor with such id updateBuildFeature public boolean updateBuildFeature(@NotNull String featureId, @NotNull String newType, @NotNull Map<String,String> newParams) Description copied from interface: BuildTypeSettings Updates build feature descriptor with specified id, changes type and parameters. Specified by: updateBuildFeature in interface BuildTypeSettings Parameters: featureId - id of build feature descriptor newType - type of build feature descriptor newParams - parameters map Returns: true if parameters of build feature descriptor were changed (descriptor with such id exists) and false otherwise findBuildFeatureById @Nullable public SBuildFeatureDescriptor findBuildFeatureById(@NotNull String featureId) Description copied from interface: BuildTypeSettings Returns build feature with specified id Specified by: findBuildFeatureById in interface BuildTypeSettings Parameters: featureId - id of the feature Returns: see above setEnabled public void setEnabled(@NotNull String paramsDescriptorId, boolean enabled) Description copied from interface: BuildTypeSettings Enables or disables descriptor with specified id in build configuration settings. This method can be used to enable or disable build runners, triggers and build features. Specified by: setEnabled in interface BuildTypeSettings Parameters: paramsDescriptorId - id of build runner, trigger or build feature enabled - true to enable, false to disable isEnabled public boolean isEnabled(@NotNull String paramsDescriptorId) Description copied from interface: BuildTypeSettings Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise. Specified by: isEnabled in interface BuildTypeSettings Parameters: paramsDescriptorId - id of build runner, trigger or build feature removeAllBuildRunners public void removeAllBuildRunners() Description copied from interface: BuildTypeEx Removes all build runners Specified by: removeAllBuildRunners in interface BuildTypeEx Specified by: removeAllBuildRunners in interface BuildTypeSettings getRunnersOrder @Nullable public String[] getRunnersOrder() Specified by: getRunnersOrder in interface BuildTypeSettings Returns: runner ids in their custom order (if such order is set), null otherwise persist public void persist(@Nullable String comment) getLastConfigModificationAction public AuditLogAction getLastConfigModificationAction() Specified by: getLastConfigModificationAction in interface BuildTypeEx getConfigurationFile @NotNull public File getConfigurationFile() Description copied from interface: BuildTypeIdentity Returns the configuration file where this build type or template is persisted (or will be persisted to). Specified by: getConfigurationFile in interface BuildTypeIdentity Specified by: getConfigurationFile in interface SPersistentEntity Returns: see above. getConfigurationFile @NotNull public File getConfigurationFile(@NotNull File projectsDir) Description copied from interface: SPersistentEntity Returns the configuration file where this entity is persisted in custom projects directory Specified by: getConfigurationFile in interface SPersistentEntity Parameters: projectsDir - path to teamcity projects directory Returns: see above getVcsRootInstanceEntries @NotNull public List<VcsRootInstanceEntry> getVcsRootInstanceEntries() Specified by: getVcsRootInstanceEntries in interface SBuildType Returns: resolved VCS root entries (entries with resolved settings: VCS root parameters and checkout rules). getVcsRootInstanceEntries @NotNull public List<VcsRootInstanceEntry> getVcsRootInstanceEntries(boolean includeSettingsRoot) Description copied from interface: BuildTypeEx Returns entries for VCS roots attached to this buildType. If buildType has an implicit settings root (not attached to buildType) and includeSettingsRoot is true, then an entry for this settings root is included in the result. Specified by: getVcsRootInstanceEntries in interface BuildTypeEx Parameters: includeSettingsRoot - whether settings root should be included in result Returns: see above isImplicitSettingsRoot public boolean isImplicitSettingsRoot(@NotNull VcsRootInstance root) Description copied from interface: BuildTypeEx Returns true if the specified VCS root is an implicit settings root, ie. this buildType's project stores settings in this root and root is not attached to this buildType Specified by: isImplicitSettingsRoot in interface BuildTypeEx Parameters: root - root of interest Returns: see above getVcsRootInstanceEntries @NotNull public List<VcsRootInstanceEntry> getVcsRootInstanceEntries(@NotNull Set<String> vcsNames, boolean includeSettingsRoot) Description copied from interface: SBuildType Returns entries corresponding to specified vcs support names Specified by: getVcsRootInstanceEntries in interface SBuildType Parameters: vcsNames - VCS support names includeSettingsRoot - whether settings root should be included in result Returns: see above getVcsRootInstanceForParent public VcsRootInstance getVcsRootInstanceForParent(@NotNull SVcsRoot parentRoot) Specified by: getVcsRootInstanceForParent in interface SBuildType Returns: VCS root instance for specified parentRoot. Parent VCS root must be attached to this configuration, otherwise null will be returned. getVcsRootInstanceEntryForParent @Nullable public VcsRootInstanceEntry getVcsRootInstanceEntryForParent(@NotNull SVcsRoot parentRoot) Specified by: getVcsRootInstanceEntryForParent in interface SBuildType Returns: VCS root instance entry for specified parentRoot. Parent VCS root must be attached to this configuration, otherwise null will be returned. getVcsRootInstances @NotNull public List<VcsRootInstance> getVcsRootInstances() Specified by: getVcsRootInstances in interface SBuildType Returns: collection of VCS root instances used in this build configuration. applyRunnersOrder public void applyRunnersOrder(@NotNull String[] ids) Description copied from interface: BuildTypeSettings Accepts array of runner identifiers and reorders them according to this array. Specified by: applyRunnersOrder in interface BuildTypeSettings Parameters: ids - runner identifiers resetRunnersOrder public void resetRunnersOrder() Description copied from interface: BuildTypeSettings Resets custom runner order to default. Specified by: resetRunnersOrder in interface BuildTypeSettings intersectsWith public boolean intersectsWith(@NotNull Dependent dependent) Description copied from interface: Dependent Returns true if this object dependencies intersect (have same nodes) with specified object dependencies. Specified by: intersectsWith in interface Dependent Parameters: dependent - another object Returns: see above compareTo public int compareTo(@NotNull BuildTypeDescriptor o) Specified by: compareTo in interface Comparable<BuildTypeDescriptor> getBuildSettings @NotNull public BuildSettings getBuildSettings() Description copied from interface: BuildTypeEx Returns build settings: settings for build (where excluded disabled options and features). Specified by: getBuildSettings in interface BuildTypeEx Returns: build settings. setExternalId public void setExternalId(@NotNull String newExternalId) throws InvalidIdentifierException, DuplicateExternalIdException Description copied from interface: BuildTypeIdentity Changes the external id of this build template or build configuration. This method persists the current entity, and can persist also dependent entities. Specified by: setExternalId in interface BuildTypeIdentity Parameters: newExternalId - new external identifier. Must be unique (case insensitively) in the scope of all build templates and build configurations (in other words, two projects with build configurations with same external id are not allowed). Throws: InvalidIdentifierException - wrong identifier DuplicateExternalIdException - a build template or a build configuration setExternalId public void setExternalId(@NotNull ConfigAction cause, @NotNull String newExternalId) throws InvalidIdentifierException, DuplicateExternalIdException Description copied from interface: BuildTypeIdentity Changes the external id of this build template or build configuration. This method persists the current entity, and can persist also dependent entities. Specified by: setExternalId in interface BuildTypeIdentity Parameters: cause - configuration action caused the change newExternalId - new external identifier. Must be unique (case insensitively) in the scope of all build templates and build configurations (in other words, two projects with build configurations with same external id are not allowed). Throws: InvalidIdentifierException - wrong identifier DuplicateExternalIdException - a build template or a build configuration listFiles @NotNull public List<VcsFile> listFiles(@NotNull String relativePath) throws VcsException Description copied from interface: VcsWorkspaceAccess Lists files in the directory specified by relativePath Specified by: listFiles in interface VcsWorkspaceAccess Parameters: relativePath - relative path regarding to the project root, "checkout root" from vcs root should not be included Returns: list of files in directory Throws: VcsException - if some problem occurred while listing files or when files cannot be listed (canListFiles() returns false) canListFiles public boolean canListFiles() Specified by: canListFiles in interface VcsWorkspaceAccess Returns: true if list files is possible, false otherwise belongsTo public boolean belongsTo(@NotNull SProject project) Description copied from interface: BuildTypeIdentity Checks whether this build type or template belongs to the specified project or one of its subprojects, transitively. Specified by: belongsTo in interface BuildTypeIdentity Specified by: belongsTo in interface SBuildType Parameters: project - the project to check this configuration to belongs to. Returns: true if belongs. getOwnVcsRootEntries @NotNull public List<VcsRootEntry> getOwnVcsRootEntries() Specified by: getOwnVcsRootEntries in interface SBuildType Returns: build configuration own VCS roots, i.e. it does not contain VCS roots inherited from template getParent @Nullable public SPersistentEntity getParent() Description copied from interface: SPersistentEntity The parent entity. Specified by: getParent in interface SPersistentEntity Returns: see above. getTags @NotNull public List<String> getTags(@NotNull SUser user) Description copied from interface: BuildTypeEx List of all private tags set for builds of this configuration by the specified user. Specified by: getTags in interface BuildTypeEx Returns: union of tags for each build for the configuration. getDummyBuild @NotNull public DummyBuild getDummyBuild() Specified by: getDummyBuild in interface BuildTypeEx getDummyBuildPromotion @NotNull public DummyBuildPromotion getDummyBuildPromotion() Specified by: getDummyBuildPromotion in interface BuildTypeEx getDummyBuildPromotion @Nullable public DummyBuildPromotion getDummyBuildPromotion(boolean createIfNotExists) Specified by: getDummyBuildPromotion in interface BuildTypeEx resetPendingChanges public void resetPendingChanges() Specified by: resetPendingChanges in interface BuildTypeEx getArtifactDirectories @NotNull public List<File> getArtifactDirectories() Specified by: getArtifactDirectories in interface BuildTypeEx Returns: list of directories where artifacts of builds of this build type are stored. List always has at least one element. The first directory in the list is a directory where new builds store their artifacts. createEditableCopy @NotNull public BuildTypeEx createEditableCopy(boolean fillSettings) Specified by: createEditableCopy in interface BuildTypeEx getOwnParameter @Nullable public Parameter getOwnParameter(@NotNull String paramName) Specified by: getOwnParameter in interface InheritableUserParametersHolder Parameters: paramName - parameter name Returns: own parameter with given name or null if there is no such parameter getOwnParametersWithoutInheritedSpec @NotNull public Collection<Parameter> getOwnParametersWithoutInheritedSpec() Specified by: getOwnParametersWithoutInheritedSpec in interface InheritableUserParametersHolder Returns: own parameters as is, with own parameters spec. getInheritedParametersCollection @NotNull public Collection<Parameter> getInheritedParametersCollection() Specified by: getInheritedParametersCollection in interface InheritableUserParametersHolder Returns: collection of inherited parameters. getOwnNonInheritedParameter @Nullable public Parameter getOwnNonInheritedParameter(@NotNull String paramName) Description copied from interface: InheritableUserParametersHolderEx Own parameter without inherited parameter spec. Specified by: getOwnNonInheritedParameter in interface InheritableUserParametersHolderEx Returns: getVersion @NotNull public PersistentEntityVersion getVersion() Description copied from interface: SPersistentEntity Returns version of this entity which can be used to check if the entity was edited or persisted. Specified by: getVersion in interface SPersistentEntity Returns: see above markPersisted public void markPersisted(long expectedEditId) Description copied from interface: SPersistentEntity Marks entity as persisted Specified by: markPersisted in interface SPersistentEntity Parameters: expectedEditId - expected editId in the end of persist. The entity will be marked as unedited if expected editId is the same as actual, ie. the entity wasn't edited while persist was running createConfigAction @NotNull public ConfigAction createConfigAction(@Nullable SUser user, @NotNull String description) Description copied from interface: SPersistentEntity Creates a config action instance associated with this entity and having the specified description. The config action object can be used in SPersistentEntity.schedulePersisting(ConfigAction) or SPersistentEntity.scheduleRemove(ConfigAction) methods to describe the performed action. Specified by: createConfigAction in interface SPersistentEntity Parameters: user - user who performs operation, or null if operation is performed by the system description - description to set to the config action object Returns: new config action isDefaultBranchExcluded public boolean isDefaultBranchExcluded() Description copied from interface: BuildTypeEx Returns true default branch is excluded in the build configuration branch filter Specified by: isDefaultBranchExcluded in interface BuildTypeEx Returns: see above getBuildTypeBranchFilter @NotNull public BranchFilter getBuildTypeBranchFilter() Specified by: getBuildTypeBranchFilter in interface SBuildType Returns: default branch filter which is applied to all branches available in this configuration since 2019.1 getBuildTypeBranchFilterUnsafe @NotNull public BranchFilter getBuildTypeBranchFilterUnsafe() throws InvalidBranchSpecException Description copied from interface: BuildTypeEx Same as SBuildType.getBuildTypeBranchFilter() but throws an exception if the branch filter is incorrect Specified by: getBuildTypeBranchFilterUnsafe in interface BuildTypeEx Throws: InvalidBranchSpecException getRelatedVcsRootInstanceIds @NotNull public Set<Long> getRelatedVcsRootInstanceIds() Description copied from interface: BuildTypeEx Returns ids of VCS root instances which reported changes associated with this build configuration. Specified by: getRelatedVcsRootInstanceIds in interface BuildTypeEx Returns: isVirtual public boolean isVirtual() Specified by: isVirtual in interface SBuildType Specified by: isVirtual in interface SPersistentEntity Returns: true if this entity is auto-generated and can be regenerated or removed by the server at any point of time, see also SProject.isVirtual() getExcludedDefaultRootInstanceIds @NotNull public Set<Long> getExcludedDefaultRootInstanceIds() Description copied from interface: BuildTypeEx Returns set of vcs root instance ids with excluded default branch Specified by: getExcludedDefaultRootInstanceIds in interface BuildTypeEx Returns: see above isDeployment public boolean isDeployment() Specified by: isDeployment in interface BuildTypeSettings Returns: true if this build configuration is doing deployment getRunBuildActionName public String getRunBuildActionName() Specified by: getRunBuildActionName in interface BuildTypeEx Returns: name of the Run build action in this configuration, this could be Run, Deploy, Upload, etc. The primary usage of this name is web interface. isCompositeBuildType public boolean isCompositeBuildType() Specified by: isCompositeBuildType in interface BuildTypeEx Specified by: isCompositeBuildType in interface BuildTypeSettings Returns: true if this build type is composite isAgentLessBuildType public boolean isAgentLessBuildType() Specified by: isAgentLessBuildType in interface BuildTypeEx Returns: true if this build type is agent less isEmptyUuid public boolean isEmptyUuid() Specified by: isEmptyUuid in interface BuildTypeEx Returns: true if this buildType has an empty uuid in its config on disk reassignIntId public void reassignIntId(@NotNull String internalId) Description copied from interface: BuildTypeEx Assigns the specified internalId to this buildType. The internalId should come from an entityId present in DB and marked as removed, otherwise an IllegalArgumentException is thrown. Specified by: reassignIntId in interface BuildTypeEx containsOwnVcsRoot public boolean containsOwnVcsRoot(long vcsRootId) Description copied from interface: BuildTypeSettings Returns true if VCS root with specified id is attached directly and is not inherited via a template Specified by: containsOwnVcsRoot in interface BuildTypeEx Specified by: containsOwnVcsRoot in interface BuildTypeSettings Parameters: vcsRootId - vcs root id Returns: true if the specified VCS root is attached to the build configuration directly and is not inherited updateRevisionsForOwnBranches public void updateRevisionsForOwnBranches(@NotNull Collection<String> logicalBranchNames) Description copied from interface: BuildTypeEx Make sure that revisions for specified logical branches are calculated and saved in dummy build promotions. These revisions are used to compute pending changes, so if some code is going to compute pending changes for a big amount of branches it makes sense to call this method first. Specified by: updateRevisionsForOwnBranches in interface BuildTypeEx setSettings public void setSettings(@NotNull BuildTypeSettingsEx newSettings) Description copied from interface: BuildTypeEx Complete replacement of settings Specified by: setSettings in interface BuildTypeEx Parameters: newSettings - new settings

Class DummyBuildType

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.BuildTypeDescriptor

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings

Field Summary

Fields inherited from interface jetbrains.buildServer.BuildTypeDescriptor

Fields inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions

Fields inherited from interface jetbrains.buildServer.serverSide.CleanupSettings

Fields inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeEx

Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolderEx

Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters

Constructor Detail

DummyBuildType

Method Detail

getEntityId

getInternalId

getName

getFullName

getDescription

getBuildTypeId

getConfigId

getExternalId

getProjectName

getImplicitRequirements

getHistory

getHistoryFull

getHistory

getLastChangesStartedBuild

getAgentCompatibilities

getAgentCompatibility

getAgentTypeCompatibility

getCanRunAndCompatibleAgentTypes

getDependencyGraph

findTops

getAgentCompatibility

getCompatibilityMap

getCompatibleAgents

processHistoryEntries

getCanRunAgents

getCanRunAndCompatibleAgents

getBuildNumbers

getRunningBuilds

getRunningBuilds

getLastChangesFinished

getLastChangesSuccessfullyFinished

setPaused

setPaused

getPauseComment

getLastPauseComment

getSourceBuildType

getProject

newRunningBuild

newAgentLessBuild

attachedToModel

createBuildPromotion

createBuildPromotion

createBuildPromotion

createBuildPromotion

createBuildCustomizer

createPersonalBuildType

createPersonalBuildType

createPersonalBuildType

addToQueue

addToQueue

getSettings

dispose

remove

unregister

setExternalId

sendExtIdChangedEvents

isTemplateAccessible

replaceInValues

textValueMatches

setName

setDescription