jetbrains.buildServer.serverSide

Interface BuildTypeTemplate

All Superinterfaces:

BuildTypeIdentity, BuildTypeOptions, BuildTypeSettings, java.lang.Comparable<BuildTypeTemplate>, CompatibleAgents, DependencySettings, Dependent, InheritableUserParametersHolder, OptionSupport, ParametersSupport, ReadOnlyUserParameters, SPersistentEntity, UserParametersHolder, VcsLabelingSettings

public interface BuildTypeTemplate
extends BuildTypeIdentity, BuildTypeSettings, CompatibleAgents, java.lang.Comparable<BuildTypeTemplate>, ParametersSupport, Dependent

Build configuration template. Contains settings of build configuration.

Since:

5.0

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_HANGING_BUILDS_DETECTION_ENABLED, BT_MAX_RUNNING_BUILDS, BT_SHOW_DEPS_CHANGES, DEFAULT_BUILD_NUMBER_PATTERN, DEFAULT_VCS_LABELING_BRANCH_FILTER, VCS_LABELING_BRANCH_FILTER

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

DEFAULT_LABEL_PATTERN

Method Summary

Modifier and Type	Method and Description
void	applyRunnersOrder(java.lang.String[] ids) Changes order of build runners in this template and in all of the inherited build configurations.
boolean	belongsTo(SProject project) Returns true if the specified project or some of its subprojects (not only direct) contains this build configuration template.
java.lang.String	getDescription()
java.lang.String	getId() Returns the internal identifier (that is used inside the database).
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
SProject	getParentProject() Deprecated. use getProject()
java.lang.String	getParentProjectId() Deprecated. use getProjectId()
SProject	getProject() Returns project to which this template belongs
java.lang.String	getProjectId() Returns internal id of the project to which this template belongs
java.lang.String	getReadOnlyReason()
java.util.Collection<SBuildType>	getUsages() Returns collection of build configurations attached to this template.
java.util.Collection<SProject>	getUsagesAsDefaultTemplate() Returns collection of projects where this template is used as a default template.
boolean	isAccessibleFrom(SProject project) Returns true if this template is accessible from specified project, i.e.
boolean	isReadOnly()
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() Persist this template settings, should be called after settings modifications to preserve template state.
void	setDescription(java.lang.String description) Sets template description

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeIdentity

getConfigurationFile, getExternalId, getFullName, getInternalId, getName, setExternalId, setExternalId, setName

Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity

getConfigId, getConfigurationFile, getParent, getVersion, markPersisted, persist, remove, schedulePersisting, schedulePersisting

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeSettings

addArtifactDependency, addBuildFeature, addBuildFeature, addBuildParameter, addBuildRunner, addBuildRunner, addBuildTrigger, addBuildTrigger, addConfigParameter, addRequirement, addVcsRoot, containsOwnVcsRoot, containsVcsRoot, findBuildFeatureById, findBuildRunnerById, findBuildRunnerByType, findRunnerParameter, findTriggerById, getArtifactDependencies, getArtifactPaths, getBuildFeatureRequirements, getBuildFeatures, getBuildFeaturesOfType, getBuildNumberPattern, getBuildParameter, getBuildParameters, getBuildParametersCollection, getBuildRunners, getBuildTriggersCollection, getCheckoutDirectory, getCheckoutRules, getCheckoutType, getConfigParameters, getConfigParametersCollection, getImplicitRequirements, getRequirements, getRunnerConditions, getRunnersOrder, getRunnerTypes, getRunTypeRequirements, getTemplate, getTemplateId, getTemplateIds, getTemplates, getTypedOption, getUndefinedParameters, getVcsRootEntries, getVcsRoots, isCompositeBuildType, isDeployment, isEnabled, isTemplateAccessible, isTemplateBased, persist, removeAllBuildRunners, removeArtifactDependency, removeBuildFeature, removeBuildParameter, removeBuildRunner, removeBuildTrigger, removeConfigParameter, removeRequirement, removeRequirement, removeVcsRoot, replaceInValues, replaceInValues, resetRunnersOrder, setArtifactDependencies, setArtifactPaths, setBuildNumberPattern, setCheckoutDirectory, setCheckoutRules, setCheckoutType, setEnabled, textValueMatches, updateBuildFeature, updateBuildRunner, updateBuildTrigger

Methods inherited from interface jetbrains.buildServer.util.OptionSupport

getChangedOptions, getDeclaredOption, getOption, getOptionDefaultValue, getOptions, getOwnOptions, setOption

Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolder

getInheritedParametersCollection, getOwnParameter, getOwnParameters, getOwnParametersCollection, getOwnParametersWithoutInheritedSpec, getParameters, getParametersCollection

Methods inherited from interface jetbrains.buildServer.serverSide.UserParametersHolder

addParameter, removeParameter

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyUserParameters

getParameter, getParameterValue

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

getLabelingRoots, getLabelingType, getLabelPattern

Methods inherited from interface jetbrains.buildServer.serverSide.CompatibleAgents

getAgentCompatibility, getCompatibilityMap, getCompatibleAgents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jetbrains.buildServer.serverSide.ParametersSupport

getParametersProvider, getValueResolver

Methods inherited from interface jetbrains.buildServer.serverSide.dependency.Dependent

getChildDependencies, intersectsWith

Methods inherited from interface jetbrains.buildServer.serverSide.dependency.DependencySettings

addDependency, getDependencies, removeDependency

Method Detail

getId

@NotNull
java.lang.String getId()

Returns the internal identifier (that is used inside the database).

Returns:

the internal identifier.

See Also:

BuildTypeIdentity.getExternalId()

getDescription

@NotNull
java.lang.String getDescription()

Returns:

template description

Since:

2018.1

setDescription

void setDescription(@NotNull
                    java.lang.String description)

Sets template description

Parameters:

description - template description

Since:

2018.1

persist

void persist()

Persist this template settings, should be called after settings modifications to preserve template state.

Specified by:

persist in interface BuildTypeSettings

Specified by:

persist in interface SPersistentEntity

getUsages

java.util.Collection<SBuildType> getUsages()

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

Returns:

see above.

getUsagesAsDefaultTemplate

java.util.Collection<SProject> getUsagesAsDefaultTemplate()

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

Returns:

see above

Since:

2017.2

getNumberOfUsages

int getNumberOfUsages()

Returns total number of this template usages (without permissions filtering) in build configurations

Returns:

see above

getNumberOfUsagesAsDefaultTemplate

int getNumberOfUsagesAsDefaultTemplate()

Returns total number of projects (without permissions filtering) using this template as a default template

Returns:

see above

Since:

2017.2

getParentProject

@NotNull
 @Deprecated
SProject getParentProject()

Deprecated. use getProject()

Returns project to which this template belongs

Returns:

see above

getParentProjectId

@NotNull
 @Deprecated
java.lang.String getParentProjectId()

Deprecated. use getProjectId()

Returns id of the project to which this template belongs

Returns:

see above

Since:

6.5

getProject

@NotNull
SProject getProject()

Returns project to which this template belongs

Specified by:

getProject in interface BuildTypeIdentity

Specified by:

getProject in interface BuildTypeSettings

Returns:

see above

getProjectId

@NotNull
java.lang.String getProjectId()

Returns internal id of the project to which this template belongs

Returns:

see above

Since:

6.5

moveToProject

void moveToProject(@NotNull
                   SProject target)
            throws InvalidVcsRootScopeException,
                   TemplateBecomesInaccessibleException

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.

Parameters:

target - target project

Throws:

InvalidVcsRootScopeException - if VCS roots used by this template will not be accessible in the target project

TemplateBecomesInaccessibleException - if template is used by configurations and won't be available for them if it is moved to target project

moveToProject

void moveToProject(@NotNull
                   ConfigAction cause,
                   @NotNull
                   SProject target)
            throws InvalidVcsRootScopeException,
                   TemplateBecomesInaccessibleException

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.

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

TemplateBecomesInaccessibleException - if template is used by configurations and won't be available for them if it is moved to target project

Since:

9.0

applyRunnersOrder

void applyRunnersOrder(@NotNull
                       java.lang.String[] ids)

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

Parameters:

ids - runner identifiers

belongsTo

boolean belongsTo(@NotNull
                  SProject project)

Returns true if the specified project or some of its subprojects (not only direct) contains this build configuration template.

Specified by:

belongsTo in interface BuildTypeIdentity

Parameters:

project - project

Returns:

see above

Since:

8.0

isAccessibleFrom

boolean isAccessibleFrom(@NotNull
                         SProject project)

Returns true if this template is accessible from specified project, i.e. it belongs to this project or to some of its parents

Parameters:

project - project to check

Returns:

see above

Since:

8.0

isReadOnly

boolean isReadOnly()

Returns:

true if this template settings are in read only mode

Since:

10.0

getReadOnlyReason

@Nullable
java.lang.String getReadOnlyReason()

Returns:

reason why the template is in read only state or null if the template is not read only

Since:

10.0.2