Package jetbrains.buildServer.serverSide

Interface BuildTypeSettingsEx

    • Method Detail

      • getProject

        @NotNull
ProjectEx getProject()
        Returns the project this build type entity belongs to.
        Specified by:
        getProject in interface BuildTypeSettings
        Returns:
        the project this build type entity belongs to.

      • setProject

        void setProject​(@NotNull
                ProjectEx project)
        Sets new project to settings object
        Parameters:
        project -

      • setParametersSupport

        void setParametersSupport​(@NotNull
                          ParametersSupport paramsSupport)

      • copySettings

        void copySettings​(@NotNull
                  BuildTypeSettingsEx source,
                  @NotNull
                  BuildTypeCopySettings copyOptions)
        Copies settings, parameters, options etc. from another instance of build type settings.
        Parameters:
        source - source settings
        copyOptions - copy options; if empty, the method regenerates setting ids for the settings that clash by ids with the inherited ones in the destination, and copies disabled and inherited settings from the source
        See Also:
        BuildTypeSettingsCopyOptions

      • copyAllSettings

        void copyAllSettings​(@NotNull
                     BuildTypeSettingsEx source)
        Copies all settings, the behaviour is the same as copySettings with empty copyOptions, i.e. it regenerates setting ids for the settings that clash by ids with the inherited ones in the destination, and copies disabled and inherited settings from the source.
        Parameters:
        source -

      • addListener

        void addListener​(@NotNull
                 BuildTypeSettingsListener listener,
                 boolean delayPropagation)
        Adds listener to the build type settings and all settings of the attached templates
        Parameters:
        listener - Listener
        delayPropagation - If true, attaching of the listener to a template is delayed until attachedToModel is called

      • getTemplateExternalId

        @Nullable
@Deprecated
String getTemplateExternalId()
        Deprecated.

      • setTemplatesOrder

        void setTemplatesOrder​(@NotNull
                       List<String> templateIds)
        Imposes new order on the associated templates. Unlike #setTemplatIds this method cannot add or remove templates.
        Parameters:
        templateIds - the existing template ids in the new order
        Throws:
        IllegalArgumentException - if the provided list of template ids does not match the templates attached with the settings

      • setTemplateIds

        void setTemplateIds​(@NotNull
                    List<String> templateIds)
        Change which templates these settings are attached to. No copying of settings or cleaning of duplicates occurs in process
        Parameters:
        templateIds -

      • applyRunnersOrder

        void applyRunnersOrder​(@NotNull
                       String[] ids,
                       boolean alwaysSetCustom)
        Apply custom order of build steps
        Parameters:
        ids - the order defined by build step ids
        alwaysSetCustom - if true, the build configuration stores the new order as a custom order even if there are no templates attached

      • dispose

        void dispose()

      • getDisabledParameterDescriptorIds

        @NotNull
Collection<String> getDisabledParameterDescriptorIds()

      • vcsRootsAccessibleInProject

        boolean vcsRootsAccessibleInProject​(@NotNull
                                    SProject project)

      • getDeclaredOption

        default <T> T getDeclaredOption​(@NotNull
                                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

      • replaceDependency

        void replaceDependency​(@NotNull
                       Dependency origDep,
                       @NotNull
                       Dependency newDep)
        Replaces original dependency object with another one

      • 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 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)
        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

      • getParameterDescriptorState

        @NotNull
default Map<String,​Boolean> getParameterDescriptorState()
        Returns:
        map of parameter descriptors states. False means the parameter descriptor is disabled, true means parameter descriptor is enabled, null means parameter descriptor state is not defined here (enabled by default).

      • setSecureDataStorage

        void setSecureDataStorage​(@NotNull
                          SecureDataStorage secureDataStorage)
        Sets secure data storage to be used by these settings when they are persisted on disk.
        Parameters:
        secureDataStorage - secure data storage
        Since:
        2017.1

      • getSecureDataStorage

        @NotNull
SecureDataStorage getSecureDataStorage()
        Returns:
        secure data storage used by these settings
        Since:
        2017.1

      • getDependencyOptions

        @Nullable
DependencyOptions getDependencyOptions​(@NotNull
                                       SBuildType buildType)
        Parameters:
        buildType - build type
        Returns:
        dependency options instance if current settings instance has snapshot dependency on specified build type or null

      • getBuildTypeBranchFilter

        @NotNull
BranchFilter getBuildTypeBranchFilter​(@NotNull
                                      ValueResolver valueResolver)
        Parameters:
        valueResolver - value resolver
        Returns:
        branch filter which is used to filter branches available in this build type
        Since:
        2019.1

      • isAgentLessBuildType

        boolean isAgentLessBuildType()