Package jetbrains.buildServer.serverSide
Interface BuildTypeTemplateEx
-
- All Superinterfaces:
BuildTypeIdentity,BuildTypeIdentityEx,BuildTypeOptions,BuildTypeSettings,BuildTypeSettingsSupport,BuildTypeTemplate,CleanupSettings,CleanupSettingsInit,Comparable<BuildTypeTemplate>,CompatibleAgents,DependencySettings,Dependent,InheritableUserParametersHolder,InheritableUserParametersHolderEx,InternalParameters,OptionSupport,ParametersSupport,ParameterSupport,ReadOnlyUserParameters,SPersistentEntity,UserParametersHolder,VcsLabelingSettings
- All Known Implementing Classes:
BuildTypeTemplateImpl,EditableTemplateCopy,InaccessibleTemplate,SecuredBuildTypeTemplate
public interface BuildTypeTemplateEx extends BuildTypeIdentityEx, CleanupSettingsInit, BuildTypeTemplate, CompatibleAgents, InheritableUserParametersHolderEx, BuildTypeSettingsSupport
- Author:
- Pavel.Sher
-
-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontainsOwnVcsRoot(long vcsRootId)Returns true if VCS root with specified id is attached directly and is not inherited via a templateBuildPromotioncreateDummyBuildPromotion()BuildTypeTemplateExcreateEditableCopy(boolean fillSettings)voiddispose()BranchSpecgetBranchSpec(SVcsRoot root)Returns branch specification for specified parent rootBuildSettingsgetBuildSettings()AuditLogActiongetLastConfigModificationAction()intgetNumberOfUsagesAsEnforcedSettings()ProjectExgetProject()Returns the project this build type entity belongs to.BuildTypeSettingsExgetSettings()Collection<SProject>getUsagesAsEnforcedSettings()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<VcsRootInstanceEntry>getVcsRootInstanceEntries()BuildTypeTemplateExinline()Creates a temporary copy of this template with all settings inherited from a project or a template inlined.booleanisAgentLessBuildType()booleanisBranchSpecDefined(boolean processDependencies)booleanisCompositeBuildType()booleanisDefaultBranchExcluded()Returns true if any of VCS roots attached to configuration exclude the default branchbooleanisDeploymentBuildType()booleanisEmptyUuid()booleanreplaceVcsRoot(SVcsRoot oldVcsRoot, SVcsRoot newVcsRoot)Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entriesvoidsetEditable(boolean editable)Enables or disables editing of the template in web UI, see alsoSPersistentEntity.isReadOnly().booleansetVcsRoots(Collection<SVcsRoot> vcsRoots)Sets VCS roots.voidunregister()Removes this object from project model.-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeIdentity
getConfigurationFile, getExternalId, getFullName, getInternalId, getName, setExternalId, setExternalId, setName
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeIdentityEx
getEntityId, sendExtIdChangedEvents, setExternalId
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeSettings
addArtifactDependency, addBuildFeature, addBuildFeature, addBuildParameter, addBuildRunner, addBuildRunner, addBuildRunner, addBuildTrigger, addBuildTrigger, addConfigParameter, addRequirement, addVcsRoot, containsVcsRoot, findBuildFeatureById, findBuildRunnerById, findBuildRunnerByType, findRunnerParameter, findTriggerById, getArtifactDependencies, getArtifactPaths, getBuildFeatureRequirements, getBuildFeatures, getBuildFeaturesOfType, getBuildNumberPattern, getBuildParameter, getBuildParameters, getBuildParametersCollection, getBuildRunners, getBuildTriggersCollection, getCheckoutDirectory, getCheckoutRules, getCheckoutType, getConfigParameters, getConfigParametersCollection, getImplicitRequirements, getReadOnlyReason, getRequirements, getRunnerConditions, getRunnersOrder, getRunnerTypes, getRunTypeRequirements, getTemplate, getTemplateId, getTemplateIds, getTemplates, getTypedOption, getUndefinedParameters, getVcsRootEntries, getVcsRoots, isDeployment, isEnabled, isReadOnly, 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, updateBuildTrigger
-
Methods inherited from interface jetbrains.buildServer.serverSide.impl.buildTypeSettings.BuildTypeSettingsSupport
getBuildFeatureSupport, getBuildRunnerSupport, getBuildTriggersSupport, getDisabledState, getOptionSupport, getRequirementSupport
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeTemplate
applyRunnersOrder, belongsTo, getAllUsages, getDescription, getId, getNumberOfUsages, getNumberOfUsagesAsDefaultTemplate, getParentProject, getParentProjectId, getProjectId, getUsages, getUsagesAsDefaultTemplate, isAccessibleFrom, moveToProject, moveToProject, persist, setDescription
-
Methods inherited from interface jetbrains.buildServer.serverSide.CleanupSettings
getCleanupOptions, getCleanupPolicies, getInheritedCleanupOptions, getInheritedCleanupPolicies, getOwnCleanupOptions, getOwnCleanupPolicies
-
Methods inherited from interface jetbrains.buildServer.serverSide.CleanupSettingsInit
addCleanupPolicy, removeCleanupPolicies, setCleanupOption
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface jetbrains.buildServer.serverSide.CompatibleAgents
getAgentCompatibility, getCompatibilityMap, getCompatibleAgents
-
Methods inherited from interface jetbrains.buildServer.serverSide.dependency.DependencySettings
addDependency, getDependencies, removeDependency
-
Methods inherited from interface jetbrains.buildServer.serverSide.dependency.Dependent
getChildDependencies, intersectsWith
-
Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolder
getInheritedParametersCollection, getOwnParameter, getOwnParameters, getOwnParametersCollection, getOwnParametersWithoutInheritedSpec, getParameters, getParametersCollection
-
Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolderEx
getOwnAndParentsNonInheritedParameter, getOwnAndParentsNonInheritedParameters, getOwnNonInheritedParameter
-
Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters
getBooleanInternalParameter, getBooleanInternalParameterOrTrue, getInternalParameterValue
-
Methods inherited from interface jetbrains.buildServer.util.OptionSupport
getChangedOptions, getDeclaredOption, getOption, getOptionDefaultValue, getOptions, getOwnOptions, setOption
-
Methods inherited from interface jetbrains.buildServer.serverSide.ParametersSupport
getParametersProvider, getValueResolver
-
Methods inherited from interface jetbrains.buildServer.serverSide.impl.buildTypeSettings.ParameterSupport
getParametersSupport
-
Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyUserParameters
getParameter, getParameterValue
-
Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity
createConfigAction, getConfigId, getConfigurationFile, getParent, getReadOnlyReason, getVersion, isReadOnly, isVirtual, markPersisted, persist, remove, schedulePersisting, schedulePersisting, scheduleRemove
-
Methods inherited from interface jetbrains.buildServer.serverSide.UserParametersHolder
addParameter, removeParameter
-
Methods inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings
getLabelingRoots, getLabelingType, getLabelPattern
-
-
-
-
Method Detail
-
getProject
@NotNull ProjectEx getProject()
Description copied from interface:BuildTypeIdentityReturns the project this build type entity belongs to.- Specified by:
getProjectin interfaceBuildTypeIdentity- Specified by:
getProjectin interfaceBuildTypeSettings- Specified by:
getProjectin interfaceBuildTypeTemplate- Returns:
- the project this build type entity belongs to.
- Since:
- 8.0
-
unregister
void unregister()
Description copied from interface:BuildTypeIdentityExRemoves this object from project model. No changes on disk are performed.- Specified by:
unregisterin interfaceBuildTypeIdentityEx
-
getLastConfigModificationAction
@Nullable AuditLogAction getLastConfigModificationAction()
-
inline
@NotNull BuildTypeTemplateEx inline()
Creates a temporary copy of this template with all settings inherited from a project or a template inlined.- Since:
- 2020.1.2
-
getVcsRootInstanceEntries
@NotNull List<VcsRootInstanceEntry> getVcsRootInstanceEntries()
-
dispose
void dispose()
-
getSettings
@NotNull BuildTypeSettingsEx getSettings()
- Specified by:
getSettingsin interfaceBuildTypeIdentityEx- Returns:
- Underlying build settings object
-
getBuildSettings
@NotNull BuildSettings getBuildSettings()
-
isBranchSpecDefined
boolean isBranchSpecDefined(boolean processDependencies)
-
getVcsBranches
@NotNull 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).- Parameters:
includeDependenciesBranches- whether to add branches from dependencies to the list or not- Returns:
- see above
-
replaceVcsRoot
boolean replaceVcsRoot(@NotNull SVcsRoot oldVcsRoot, @NotNull SVcsRoot newVcsRoot)Replaces existing VCS root entry in settings with a new one, maintaining the order of the root entries- Parameters:
oldVcsRoot- VCS root to be replacednewVcsRoot- 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)
- Since:
- 10.0
-
setVcsRoots
boolean setVcsRoots(@NotNull Collection<SVcsRoot> vcsRoots)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.- Parameters:
vcsRoots-- Returns:
- true if any changes occured
- Since:
- 10.0
-
setEditable
void setEditable(boolean editable)
Enables or disables editing of the template in web UI, see alsoSPersistentEntity.isReadOnly().SBuildType.persist()method must be called afterwards.- Parameters:
editable- true to enable editing and false to disable
-
getBranchSpec
@NotNull BranchSpec getBranchSpec(@NotNull SVcsRoot root)
Returns branch specification for specified parent root- Parameters:
root- root of interest- Returns:
- see above
- Since:
- 2017.1
-
isDefaultBranchExcluded
boolean isDefaultBranchExcluded()
Returns true if any of VCS roots attached to configuration exclude the default branch- Returns:
- see above
- Since:
- 2017.1
-
isDeploymentBuildType
boolean isDeploymentBuildType()
- Returns:
- true if build configuration inherited from this template is doing deployment
- Since:
- 2017.1
-
isCompositeBuildType
boolean isCompositeBuildType()
- Specified by:
isCompositeBuildTypein interfaceBuildTypeSettings- Returns:
- true if build configuration inherited from this template is composite
- Since:
- 2017.2
-
isAgentLessBuildType
boolean isAgentLessBuildType()
- Since:
- 2020.2
-
isEmptyUuid
boolean isEmptyUuid()
- Returns:
- true if this template has an empty uuid in its config on disk
-
getUsagesAsEnforcedSettings
Collection<SProject> getUsagesAsEnforcedSettings()
- Returns:
- a collection of projects that use the template to represent their enforced settings
-
getNumberOfUsagesAsEnforcedSettings
int getNumberOfUsagesAsEnforcedSettings()
- Returns:
- a number of projects that use the template to represent their enforced settings
-
containsOwnVcsRoot
boolean containsOwnVcsRoot(long vcsRootId)
Description copied from interface:BuildTypeSettingsReturns true if VCS root with specified id is attached directly and is not inherited via a template- Specified by:
containsOwnVcsRootin interfaceBuildTypeSettings- Parameters:
vcsRootId- vcs root id- Returns:
- true if the specified VCS root is attached to the temlate directly and is not inherited
- Since:
- 2019.2
-
createDummyBuildPromotion
BuildPromotion createDummyBuildPromotion()
- Returns:
- dummy build promotion
- Since:
- 2019.2.2
-
createEditableCopy
BuildTypeTemplateEx createEditableCopy(boolean fillSettings)
-
-