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

All Implemented Interfaces:

Comparable<BuildTypeTemplate>, BuildTypeIdentity, BuildTypeIdentityEx, BuildTypeOptions, BuildTypeSettings, BuildTypeTemplate, BuildTypeTemplateEx, CleanupSettings, CleanupSettingsInit, CompatibleAgents, DependencySettings, Dependent, BuildTypeSettingsSupport, ParameterSupport, InheritableUserParametersHolder, InheritableUserParametersHolderEx, InternalParameters, ParametersSupport, ReadOnlyUserParameters, SPersistentEntity, UserParametersHolder, VcsLabelingSettings, OptionSupport
```
public class EditableTemplateCopy
extends Object
implements BuildTypeTemplateEx
```

Nested Class Summary
- 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.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
`EditableTemplateCopy(BuildTypeTemplateContext context, ProjectEx project, EntityId<String> entityId, BuildTypeSettingsEx settings, String name, String description, boolean emptyUuid)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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.
`boolean`	`addVcsRoot(SVcsRoot root)`	Adds VCS root to the build configuration with default checkout rules.
`void`	`applyRunnersOrder(String[] ids)`	Changes order of build runners in this template and in all of the inherited build configurations.
`boolean`	`belongsTo(SProject project)`	Checks whether this build type or template belongs to the specified project or one of its subprojects, transitively.
`int`	`compareTo(BuildTypeTemplate 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
`ConfigAction`	`createConfigAction(SUser user, String description)`	Creates a config action instance associated with this entity and having the specified description.
`BuildPromotion`	`createDummyBuildPromotion()`
`BuildTypeTemplateEx`	`createEditableCopy(boolean fillSettings)`
`void`	`dispose()`
`SBuildFeatureDescriptor`	`findBuildFeatureById(String featureId)`	Returns build feature with specified id
`SBuildRunnerDescriptor`	`findBuildRunnerById(String runnerId)`	Finds build runner by its' id
`SBuildRunnerDescriptor`	`findBuildRunnerByType(String runnerType)`	Finds build runner by its' type.
`String`	`findRunnerParameter(String paramName)`	Searches runner parameter in all build runners and returns value of the first found parameter with given name.
`BuildTriggerDescriptor`	`findTriggerById(String triggerId)`	Finds build trigger descriptor by its' id
`CompatibilityResult`	`getAgentCompatibility(AgentDescription agentDescription)`	Fetches compatibility information for given agent description
`Collection<SBuildType>`	`getAllUsages()`	Same as #getUsages() but also returns configurations that use this template as default template
`List<SArtifactDependency>`	`getArtifactDependencies()`	Returns artifacts this build configuration depending on.
`String`	`getArtifactPaths()`	Returns build artifact paths.
`BranchSpec`	`getBranchSpec(SVcsRoot root)`	Returns branch specification for specified parent root
`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 type)`	Returns all build features of specified type.
`ContainerWithDisabled<String,SBuildFeatureDescriptor>`	`getBuildFeatureSupport()`
`String`	`getBuildNumberPattern()`	Returns current build number pattern
`String`	`getBuildParameter(String key)`	Returns build parameter by parameter key
`Map<String,String>`	`getBuildParameters()`	Return 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
`ContainerWithDisabled<String,SBuildRunnerDescriptor>`	`getBuildRunnerSupport()`
`BuildSettings`	`getBuildSettings()`
`Collection<BuildTriggerDescriptor>`	`getBuildTriggersCollection()`	Returns collection of build trigger settings
`ContainerWithDisabled<String,BuildTriggerDescriptor>`	`getBuildTriggersSupport()`
`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
`<T> T`	`getDeclaredOption(Option<T> option)`	Get option value declared in this BuildTypeSettings
`List<Dependency>`	`getDependencies()`	Get existing dependencies, empty collection when no dependencies exist
`String`	`getDescription()`
`Container<String,Boolean>`	`getDisabledState()`
`EntityId<String>`	`getEntityId()`	Returns the instance of the entity identifier.
`String`	`getExternalId()`	Returns the external identifier.
`String`	`getFullName()`	Name of the project and name of the identity.
`String`	`getId()`	Returns the internal identifier (that is used inside the database).
`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()`
`AuditLogAction`	`getLastConfigModificationAction()`
`String`	`getName()`	The name of the identity.
`int`	`getNumberOfUsages()`	Returns total number of this template usages (without permissions filtering) in build configurations
`int`	`getNumberOfUsagesAsDefaultTemplate()`	Returns total number of projects (without permissions filtering) using this template as a default template
`int`	`getNumberOfUsagesAsEnforcedSettings()`
`<T> T`	`getOption(Option<T> option)`	Get option value
`<T> T`	`getOptionDefaultValue(Option<T> option)`
`Collection<Option>`	`getOptions()`
`ContainerWithInherited<Option<Object>,OptionValue<Object>>`	`getOptionSupport()`
`Map<String,Boolean>`	`getOwnCleanupOptions()`
`Collection<HistoryRetentionPolicy>`	`getOwnCleanupPolicies()`
`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()`
`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.
`ContainerWithInherited<String,Parameter>`	`getParametersSupport()`
`String`	`getParameterValue(String paramName)`
`SPersistentEntity`	`getParent()`	The parent entity.
`SProject`	`getParentProject()`	Returns project to which this template belongs
`String`	`getParentProjectId()`	Returns id of the project to which this template belongs
`ProjectEx`	`getProject()`	Returns the project this build type entity belongs to.
`String`	`getProjectId()`	Returns internal id of the project to which this template belongs
`ReadOnlyReason`	`getReadOnlyReason()`
`List<Requirement>`	`getRequirements()`	Get list of explicit requirements for build agents which can run this build configuration.
`ContainerWithDisabled<String,Requirement>`	`getRequirementSupport()`
`BuildStepConditions`	`getRunnerConditions(SBuildRunnerDescriptor descriptor)`
`String[]`	`getRunnersOrder()`
`Collection<String>`	`getRunnerTypes()`	Returns types of the runners attached to these settings
`List<Requirement>`	`getRunTypeRequirements()`	Returns list of additional agent requirements imposed by configured runners.
`BuildTypeSettingsEx`	`getSettings()`
`BuildTypeTemplate`	`getTemplate()`	Deprecated.
`String`	`getTemplateId()`	Deprecated.
`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.
`<T> TypedValue<T>`	`getTypedOption(Option<T> option)`	Get option extended value.
`List<String>`	`getUndefinedParameters()`	Returns collection of parameter names (config and build params) referenced in the build configuration settings but without values provided.
`Collection<SBuildType>`	`getUsages()`	Returns collection of build configurations attached to this template.
`Collection<SProject>`	`getUsagesAsDefaultTemplate()`	Returns collection of projects where this template is used as a default template.
`Collection<SProject>`	`getUsagesAsEnforcedSettings()`
`ValueResolver`	`getValueResolver()`	Returns value resolver which can be used to resolve references in values
`List<Branch>`	`getVcsBranches(boolean includeDependenciesBranches)`	All VCS branches from VCS roots attached to this template and VCS branches from dependencies (if parameter includeDependenciesBranches is true).
`List<VcsRootEntry>`	`getVcsRootEntries()`	Returns all entries of vcs roots.
`List<VcsRootInstanceEntry>`	`getVcsRootInstanceEntries()`
`List<SVcsRoot>`	`getVcsRoots()`	Returns all roots currently attached to this configuration
`PersistentEntityVersion`	`getVersion()`	Returns version of this entity which can be used to check if the entity was edited or persisted.
`BuildTypeTemplateEx`	`inline()`	Creates a temporary copy of this template 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`	`isAccessibleFrom(SProject project)`	Returns true if this template is accessible from specified project, i.e.
`boolean`	`isAgentLessBuildType()`
`boolean`	`isBranchSpecDefined(boolean processDependencies)`
`boolean`	`isCompositeBuildType()`
`boolean`	`isDefaultBranchExcluded()`	Returns true if any of VCS roots attached to configuration exclude the default branch
`boolean`	`isDeployment()`
`boolean`	`isDeploymentBuildType()`
`boolean`	`isEmptyUuid()`
`boolean`	`isEnabled(String parametersDescriptorId)`	Returns true if descriptor with specified id (runner, trigger or build feature) is enabled and false otherwise.
`boolean`	`isReadOnly()`
`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.
`void`	`markPersisted(long expectedEditId)`	Marks entity as persisted
`void`	`moveToProject(ConfigAction cause, SProject target)`	Moves this template to the specified project.
`void`	`moveToProject(SProject target)`	Moves this template to the specified project.
`void`	`persist()`	Persists this entity instance onto disk.
`void`	`persist(ConfigAction cause)`	Persists this entity on disk.
`void`	`remove()`	Removes this entity.
`void`	`removeAllBuildRunners()`	Removes all build runners from these settings
`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 parameterName)`	Removes first requirement with the specified property name from the configuration.
`void`	`removeRequirement(Requirement requirement)`	Removes a requirement from the configuration.
`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`	`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)`	Sets template description
`void`	`setEditable(boolean editable)`	Enables or disables editing of the template in web UI, see also `SPersistentEntity.isReadOnly()`.
`void`	`setEnabled(String parametersDescriptorId, 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 name)`	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
`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`	`unregister()`	Removes this object from project model.
`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 newName, String newType, Map<String,String> newParams)`	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.

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.InheritableUserParametersHolderEx
getOwnAndParentsNonInheritedParameter, getOwnAndParentsNonInheritedParameters

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

Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity
isVirtual

- Constructor Detail
  - EditableTemplateCopy
```
public EditableTemplateCopy(@NotNull
                            BuildTypeTemplateContext context,
                            @NotNull
                            ProjectEx project,
                            @NotNull
                            EntityId<String> entityId,
                            @NotNull
                            BuildTypeSettingsEx settings,
                            @NotNull
                            String name,
                            @Nullable
                            String description,
                            boolean emptyUuid)
```
- Method Detail
  - getProject
```
@NotNull
public ProjectEx getProject()
```
    Description copied from interface: BuildTypeIdentity
    
    Returns the project this build type entity belongs to.
    
    Specified by:
    
    getProject in interface BuildTypeIdentity
    
    Specified by:
    
    getProject in interface BuildTypeSettings
    
    Specified by:
    
    getProject in interface BuildTypeTemplate
    
    Specified by:
    
    getProject in interface BuildTypeTemplateEx
    
    Returns:
    
    the project this build type entity belongs to.
  - getBuildSettings
```
@NotNull
public BuildSettings getBuildSettings()
```
    Specified by:
    
    getBuildSettings in interface BuildTypeTemplateEx
  - getSettings
```
@NotNull
public BuildTypeSettingsEx getSettings()
```
    Specified by:
    
    getSettings in interface BuildTypeIdentityEx
    
    Specified by:
    
    getSettings in interface BuildTypeTemplateEx
    
    Returns:
    
    Underlying build settings object
  - removeAllBuildRunners
```
public void removeAllBuildRunners()
```
    Description copied from interface: BuildTypeSettings
    
    Removes all build runners from these settings
    
    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
  - inline
```
@NotNull
public BuildTypeTemplateEx inline()
```
    Description copied from interface: BuildTypeTemplateEx
    
    Creates a temporary copy of this template with all settings inherited from a project or a template inlined.
    
    Specified by:
    
    inline in interface BuildTypeTemplateEx
  - createEditableCopy
```
@NotNull
public BuildTypeTemplateEx createEditableCopy(boolean fillSettings)
```
    Specified by:
    
    createEditableCopy in interface BuildTypeTemplateEx
  - getId
```
@NotNull
public String getId()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns the internal identifier (that is used inside the database).
    
    Specified by:
    
    getId in interface BuildTypeTemplate
    
    Returns:
    
    the internal identifier.
    
    See Also:
    
    BuildTypeIdentity.getExternalId()
  - 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.
  - 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
  - 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
  - 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
  - findBuildRunnerByType
```
@Nullable
public SBuildRunnerDescriptor findBuildRunnerByType(@NotNull
                                                    String runnerType)
```
    Description copied from interface: BuildTypeSettings
    
    Finds build runner by its' type. If there is more than one build runner, returns the first one.
    
    Specified by:
    
    findBuildRunnerByType in interface BuildTypeSettings
    
    Parameters:
    
    runnerType - type of the runner
    
    Returns:
    
    build runner or null if runner was not found
  - getBuildParameter
```
public String getBuildParameter(String key)
```
    Description copied from interface: BuildTypeSettings
    
    Returns build parameter by parameter key
    
    Specified by:
    
    getBuildParameter in interface BuildTypeSettings
    
    Parameters:
    
    key - parameter key
    
    Returns:
    
    build parameter by parameter key
  - getBuildParameters
```
@NotNull
public Map<String,String> getBuildParameters()
```
    Description copied from interface: BuildTypeSettings
    
    Return map of build parameters specified by user. Each build parameter has name and value. Name of each parameter starts from a prefix: env. or system. Value may by either simple string, or may contain references to other parameters in form %env.HOME% or %system.os.name% or %system.agent.name%
    
    Specified by:
    
    getBuildParameters in interface BuildTypeSettings
    
    Returns:
    
    see above
  - getParameters
```
@NotNull
public Map<String,String> getParameters()
```
    Description copied from interface: ReadOnlyUserParameters
    
    Returns map of build and configuration parameters.
    
    Specified by:
    
    getParameters in interface InheritableUserParametersHolder
    
    Specified by:
    
    getParameters in interface ReadOnlyUserParameters
    
    Returns:
    
    merged map of parameters, i.e. all parameters inherited from parent holders and own parameters
  - 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
  - getRunnerTypes
```
@NotNull
public Collection<String> getRunnerTypes()
```
    Description copied from interface: BuildTypeSettings
    
    Returns types of the runners attached to these settings
    
    Specified by:
    
    getRunnerTypes in interface BuildTypeSettings
    
    Returns:
    
    see above
  - getCheckoutType
```
@NotNull
public BuildTypeDescriptor.CheckoutType getCheckoutType()
```
    Description copied from interface: BuildTypeSettings
    
    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. This method returns actual checkout type, which may differ from the value set by BuildTypeSettings.setCheckoutType(jetbrains.buildServer.BuildTypeDescriptor.CheckoutType)
    
    Specified by:
    
    getCheckoutType in interface BuildTypeSettings
    
    Returns:
    
    method to get sources on agent.
  - getProjectId
```
@NotNull
public String getProjectId()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns internal id of the project to which this template belongs
    
    Specified by:
    
    getProjectId in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - 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 BuildTypeTemplate
    
    Parameters:
    
    project - the project to check this configuration to belongs to.
    
    Returns:
    
    true if belongs.
  - isAccessibleFrom
```
public boolean isAccessibleFrom(@NotNull
                                SProject project)
```
    Description copied from interface: BuildTypeTemplate
    
    Returns true if this template is accessible from specified project, i.e. it belongs to this project or to some of its parents
    
    Specified by:
    
    isAccessibleFrom in interface BuildTypeTemplate
    
    Parameters:
    
    project - project to check
    
    Returns:
    
    see above
  - getInternalId
```
@NotNull
public String getInternalId()
```
    Description copied from interface: BuildTypeIdentity
    
    Returns the internal identifier.
    
    Specified by:
    
    getInternalId in interface BuildTypeIdentity
    
    Returns:
    
    the internal identifier.
  - getExternalId
```
@NotNull
public String getExternalId()
```
    Description copied from interface: BuildTypeIdentity
    
    Returns the external identifier.
    
    Specified by:
    
    getExternalId in interface BuildTypeIdentity
    
    Specified by:
    
    getExternalId in interface SPersistentEntity
    
    Returns:
    
    the external identifier.
  - 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
```
@Nullable
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 newName,
                                 @NotNull
                                 String newType,
                                 @NotNull
                                 Map<String,String> newParams)
```
    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
    
    newName - new runner name
    
    newType - new type of the runner
    
    newParams - 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
    
    Returns:
    
    see above
  - applyRunnersOrder
```
public void applyRunnersOrder(@NotNull
                              String[] ids)
```
    Description copied from interface: BuildTypeTemplate
    
    Changes order of build runners in this template and in all of the inherited build configurations. Note that after that persist operation invoked on the template will also persist inherited build configurations.
    
    Specified by:
    
    applyRunnersOrder in interface BuildTypeSettings
    
    Specified by:
    
    applyRunnersOrder in interface BuildTypeTemplate
    
    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
  - findBuildRunnerById
```
@Nullable
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
```
@Nullable
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
  - 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.
  - getVcsRoots
```
@NotNull
public List<SVcsRoot> getVcsRoots()
```
    Description copied from interface: BuildTypeSettings
    
    Returns all roots currently attached to this configuration
    
    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
    
    Returns:
    
    see above
  - findTriggerById
```
@Nullable
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.
  - 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
    
    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: BuildTypeTemplateEx
    
    Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entries
    
    Specified by:
    
    replaceVcsRoot in interface BuildTypeTemplateEx
    
    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: BuildTypeTemplateEx
    
    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 BuildTypeTemplateEx
    
    Returns:
    
    true if any changes occured
  - setEditable
```
public void setEditable(boolean editable)
```
    Description copied from interface: BuildTypeTemplateEx
    
    Enables or disables editing of the template in web UI, see also SPersistentEntity.isReadOnly(). SBuildType.persist() method must be called afterwards.
    
    Specified by:
    
    setEditable in interface BuildTypeTemplateEx
    
    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
    
    Parameters:
    
    root - VCS root
    
    Returns:
    
    checkout rules or null if specified VCS root is not attached to the build configuration
  - 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
  - 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
  - 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
  - getTemplate
```
@Deprecated
@Nullable
public BuildTypeTemplate getTemplate()
```
    Deprecated.
    
    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
  - 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
  - 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
```
@Nullable
@Deprecated
public String getTemplateId()
```
    Deprecated.
    
    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
  - 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
  - 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
  - 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 parameterName)
```
    Description copied from interface: BuildTypeSettings
    
    Removes first requirement with the specified property name from the configuration.
    
    Specified by:
    
    removeRequirement in interface BuildTypeSettings
    
    Parameters:
    
    parameterName - 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
  - 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
  - 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
  - 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
    
    Returns:
    
    collection of configured build features
  - getBuildFeaturesOfType
```
@NotNull
public Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull
                                                                  String type)
```
    Description copied from interface: BuildTypeSettings
    
    Returns all build features of specified type.
    
    Specified by:
    
    getBuildFeaturesOfType in interface BuildTypeSettings
    
    Returns:
    
    see above
  - removeBuildFeature
```
@Nullable
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 parametersDescriptorId,
                       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:
    
    parametersDescriptorId - id of build runner, trigger or build feature
    
    enabled - true to enable, false to disable
  - isEnabled
```
public boolean isEnabled(@NotNull
                         String parametersDescriptorId)
```
    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:
    
    parametersDescriptorId - id of build runner, trigger or build feature
  - getTypedOption
```
@NotNull
public <T> TypedValue<T> getTypedOption(@NotNull
                                        Option<T> option)
```
    Description copied from interface: BuildTypeSettings
    
    Get option extended value. See TypedValue. When the option is not defined in this Settings TypedValue will contain null in getValue()
    
    Specified by:
    
    getTypedOption in interface BuildTypeSettings
  - 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
  - getInheritedCleanupOptions
```
@NotNull
public Map<String,Boolean> getInheritedCleanupOptions()
```
    Specified by:
    
    getInheritedCleanupOptions in interface CleanupSettings
  - 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
  - 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
  - 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).
  - 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
  - getDeclaredOption
```
@Nullable
public <T> T getDeclaredOption(Option<T> option)
```
    Description copied from interface: OptionSupport
    
    Get option value declared in this BuildTypeSettings
    
    Specified by:
    
    getDeclaredOption in interface OptionSupport
    
    Parameters:
    
    option - option to retrieve value for
    
    Returns:
    
    value of the option. If value wasn't set, null is returned
  - 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
  - getParent
```
@Nullable
public SPersistentEntity getParent()
```
    Description copied from interface: SPersistentEntity
    
    The parent entity.
    
    Specified by:
    
    getParent in interface SPersistentEntity
    
    Returns:
    
    see above.
  - 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
  - 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
  - getName
```
@NotNull
public String getName()
```
    Description copied from interface: BuildTypeIdentity
    
    The name of the identity.
    
    Specified by:
    
    getName in interface BuildTypeIdentity
    
    Specified by:
    
    getName in interface SPersistentEntity
    
    Returns:
    
    see above.
    
    See Also:
    
    BuildTypeIdentity.getFullName(), BuildTypeIdentity.setName(String)
  - setName
```
public void setName(@NotNull
                    String name)
```
    Description copied from interface: BuildTypeIdentity
    
    Sets name of this build type or template
    
    Specified by:
    
    setName in interface BuildTypeIdentity
    
    Parameters:
    
    name - the new name
    
    See Also:
    
    BuildTypeIdentity.getName(), BuildTypeIdentity.getFullName()
  - getFullName
```
@NotNull
public String getFullName()
```
    Description copied from interface: BuildTypeIdentity
    
    Name of the project and name of the identity.
    
    Specified by:
    
    getFullName in interface BuildTypeIdentity
    
    See Also:
    
    BuildTypeIdentity.getName()
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface BuildTypeTemplate
    
    Returns:
    
    template description
  - setDescription
```
public void setDescription(@Nullable
                           String description)
```
    Description copied from interface: BuildTypeTemplate
    
    Sets template description
    
    Specified by:
    
    setDescription in interface BuildTypeTemplate
    
    Parameters:
    
    description - template description
  - 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
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface BuildTypeTemplateEx
  - unregister
```
public void unregister()
```
    Description copied from interface: BuildTypeIdentityEx
    
    Removes this object from project model. No changes on disk are performed.
    
    Specified by:
    
    unregister in interface BuildTypeIdentityEx
    
    Specified by:
    
    unregister in interface BuildTypeTemplateEx
  - 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
  - getLastConfigModificationAction
```
@Nullable
public AuditLogAction getLastConfigModificationAction()
```
    Specified by:
    
    getLastConfigModificationAction in interface BuildTypeTemplateEx
  - getBranchSpec
```
@NotNull
public BranchSpec getBranchSpec(@NotNull
                                SVcsRoot root)
```
    Description copied from interface: BuildTypeTemplateEx
    
    Returns branch specification for specified parent root
    
    Specified by:
    
    getBranchSpec in interface BuildTypeTemplateEx
    
    Parameters:
    
    root - root of interest
    
    Returns:
    
    see above
  - isBranchSpecDefined
```
public boolean isBranchSpecDefined(boolean processDependencies)
```
    Specified by:
    
    isBranchSpecDefined in interface BuildTypeTemplateEx
  - getVcsBranches
```
@NotNull
public List<Branch> getVcsBranches(boolean includeDependenciesBranches)
```
    Description copied from interface: BuildTypeTemplateEx
    
    All VCS branches from VCS roots attached to this template and VCS branches from dependencies (if parameter includeDependenciesBranches is true).
    
    Specified by:
    
    getVcsBranches in interface BuildTypeTemplateEx
    
    Parameters:
    
    includeDependenciesBranches - whether to add branches from dependencies to the list or not
    
    Returns:
    
    see above
  - moveToProject
```
public void moveToProject(@NotNull
                          SProject target)
                   throws InvalidVcsRootScopeException
```
    Description copied from interface: BuildTypeTemplate
    
    Moves this template to the specified project. Note that if there are local VCS roots attached to this template, they will be shared. If sharing is impossible due to lack of access rights, AccessDeniedException will be thrown.
    
    Specified by:
    
    moveToProject in interface BuildTypeTemplate
    
    Parameters:
    
    target - target project
    
    Throws:
    
    InvalidVcsRootScopeException - if VCS roots used by this template will not be accessible in the target project
  - moveToProject
```
public void moveToProject(@NotNull
                          ConfigAction cause,
                          @NotNull
                          SProject target)
                   throws InvalidVcsRootScopeException
```
    Description copied from interface: BuildTypeTemplate
    
    Moves this template to the specified project. Note that if there are local VCS roots attached to this template, they will be shared. If sharing is impossible due to lack of access rights, AccessDeniedException will be thrown.
    
    Specified by:
    
    moveToProject in interface BuildTypeTemplate
    
    Parameters:
    
    cause - config action caused the change
    
    target - target project
    
    Throws:
    
    InvalidVcsRootScopeException - if VCS roots used by this template will not be accessible in the target project
  - getVcsRootInstanceEntries
```
@NotNull
public List<VcsRootInstanceEntry> getVcsRootInstanceEntries()
```
    Specified by:
    
    getVcsRootInstanceEntries in interface BuildTypeTemplateEx
  - 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
  - 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
  - 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 BuildTypeTemplate
    
    Specified by:
    
    persist in interface SPersistentEntity
    
    Throws:
    
    PersistFailedException - if persisting failed
  - getUsages
```
public Collection<SBuildType> getUsages()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns collection of build configurations attached to this template. This does not include the build configurations that use this template because it is defined as default template in the respective projects
    
    Specified by:
    
    getUsages in interface BuildTypeTemplate
    
    Returns:
    
    see above.
  - getAllUsages
```
public Collection<SBuildType> getAllUsages()
```
    Description copied from interface: BuildTypeTemplate
    
    Same as #getUsages() but also returns configurations that use this template as default template
    
    Specified by:
    
    getAllUsages in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - getUsagesAsDefaultTemplate
```
public Collection<SProject> getUsagesAsDefaultTemplate()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns collection of projects where this template is used as a default template. This does not include projects that use it as a default template because it is set up as such in one of the higher level projects in their paths
    
    Specified by:
    
    getUsagesAsDefaultTemplate in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - getNumberOfUsages
```
public int getNumberOfUsages()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns total number of this template usages (without permissions filtering) in build configurations
    
    Specified by:
    
    getNumberOfUsages in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - getNumberOfUsagesAsDefaultTemplate
```
public int getNumberOfUsagesAsDefaultTemplate()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns total number of projects (without permissions filtering) using this template as a default template
    
    Specified by:
    
    getNumberOfUsagesAsDefaultTemplate in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - getParentProject
```
@NotNull
public SProject getParentProject()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns project to which this template belongs
    
    Specified by:
    
    getParentProject in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - getParentProjectId
```
@NotNull
public String getParentProjectId()
```
    Description copied from interface: BuildTypeTemplate
    
    Returns id of the project to which this template belongs
    
    Specified by:
    
    getParentProjectId in interface BuildTypeTemplate
    
    Returns:
    
    see above
  - 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
  - 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.
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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: BuildTypeTemplateEx
    
    Returns true if any of VCS roots attached to configuration exclude the default branch
    
    Specified by:
    
    isDefaultBranchExcluded in interface BuildTypeTemplateEx
    
    Returns:
    
    see above
  - isDeploymentBuildType
```
public boolean isDeploymentBuildType()
```
    Specified by:
    
    isDeploymentBuildType in interface BuildTypeTemplateEx
    
    Returns:
    
    true if build configuration inherited from this template is doing deployment
  - isDeployment
```
public boolean isDeployment()
```
    Specified by:
    
    isDeployment in interface BuildTypeSettings
    
    Returns:
    
    true if this build configuration is doing deployment
  - isCompositeBuildType
```
public boolean isCompositeBuildType()
```
    Specified by:
    
    isCompositeBuildType in interface BuildTypeSettings
    
    Specified by:
    
    isCompositeBuildType in interface BuildTypeTemplateEx
    
    Returns:
    
    true if build configuration inherited from this template is composite
  - isAgentLessBuildType
```
public boolean isAgentLessBuildType()
```
    Specified by:
    
    isAgentLessBuildType in interface BuildTypeTemplateEx
  - isEmptyUuid
```
public boolean isEmptyUuid()
```
    Specified by:
    
    isEmptyUuid in interface BuildTypeTemplateEx
    
    Returns:
    
    true if this template has an empty uuid in its config on disk
  - getUsagesAsEnforcedSettings
```
public Collection<SProject> getUsagesAsEnforcedSettings()
```
    Specified by:
    
    getUsagesAsEnforcedSettings in interface BuildTypeTemplateEx
    
    Returns:
    
    a collection of projects that use the template to represent their enforced settings
  - getNumberOfUsagesAsEnforcedSettings
```
public int getNumberOfUsagesAsEnforcedSettings()
```
    Specified by:
    
    getNumberOfUsagesAsEnforcedSettings in interface BuildTypeTemplateEx
    
    Returns:
    
    a number of projects that use the template to represent their enforced settings
  - 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 BuildTypeSettings
    
    Specified by:
    
    containsOwnVcsRoot in interface BuildTypeTemplateEx
    
    Parameters:
    
    vcsRootId - vcs root id
    
    Returns:
    
    true if the specified VCS root is attached to the temlate directly and is not inherited
  - createDummyBuildPromotion
```
public BuildPromotion createDummyBuildPromotion()
```
    Specified by:
    
    createDummyBuildPromotion in interface BuildTypeTemplateEx
    
    Returns:
    
    dummy build promotion
  - compareTo
```
public int compareTo(@NotNull
                     BuildTypeTemplate o)
```
    Specified by:
    
    compareTo in interface Comparable<BuildTypeTemplate>
  - getOptionSupport
```
@NotNull
public ContainerWithInherited<Option<Object>,OptionValue<Object>> getOptionSupport()
```
    Specified by:
    
    getOptionSupport in interface BuildTypeSettingsSupport
  - getBuildFeatureSupport
```
@NotNull
public ContainerWithDisabled<String,SBuildFeatureDescriptor> getBuildFeatureSupport()
```
    Specified by:
    
    getBuildFeatureSupport in interface BuildTypeSettingsSupport
  - getRequirementSupport
```
@NotNull
public ContainerWithDisabled<String,Requirement> getRequirementSupport()
```
    Specified by:
    
    getRequirementSupport in interface BuildTypeSettingsSupport
  - getBuildRunnerSupport
```
@NotNull
public ContainerWithDisabled<String,SBuildRunnerDescriptor> getBuildRunnerSupport()
```
    Specified by:
    
    getBuildRunnerSupport in interface BuildTypeSettingsSupport
  - getBuildTriggersSupport
```
@NotNull
public ContainerWithDisabled<String,BuildTriggerDescriptor> getBuildTriggersSupport()
```
    Specified by:
    
    getBuildTriggersSupport in interface BuildTypeSettingsSupport
  - getDisabledState
```
@NotNull
public Container<String,Boolean> getDisabledState()
```
    Specified by:
    
    getDisabledState in interface BuildTypeSettingsSupport
  - getParametersSupport
```
@NotNull
public ContainerWithInherited<String,Parameter> getParametersSupport()
```
    Specified by:
    
    getParametersSupport in interface ParameterSupport

Class EditableTemplateCopy

Nested Class Summary

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.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.InheritableUserParametersHolderEx

Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters

Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity

Constructor Detail

EditableTemplateCopy

Method Detail

getProject

getBuildSettings

getSettings

removeAllBuildRunners

getRunnersOrder

inline

createEditableCopy

getId

getEntityId

addCleanupPolicy

getCleanupPolicies

getOwnCleanupPolicies

getInheritedCleanupPolicies

getCleanupOptions

getOwnCleanupOptions

findBuildRunnerByType

getBuildParameter

getBuildParameters

getParameters

getParameterValue

getRunnerTypes

getCheckoutType

getProjectId

belongsTo

isAccessibleFrom

getInternalId

getExternalId

getRunTypeRequirements

getBuildFeatureRequirements

addBuildRunner

addBuildRunner

addBuildRunner

removeBuildRunner

updateBuildRunner

getBuildRunners

applyRunnersOrder

resetRunnersOrder

findBuildRunnerById

findRunnerParameter

getRunnerConditions

getBuildParametersCollection

addBuildParameter

removeBuildParameter

getVcsRoots

addBuildTrigger

addBuildTrigger

removeBuildTrigger

updateBuildTrigger

updateBuildTrigger

getBuildTriggersCollection

findTriggerById

setCheckoutType

setCheckoutDirectory

getCheckoutDirectory

setArtifactPaths

getArtifactPaths

getArtifactDependencies

setArtifactDependencies

addArtifactDependency

removeArtifactDependency

containsVcsRoot

getVcsRootEntries

addVcsRoot