jetbrains.buildServer.serverSide

Interface BuildCustomizer

public interface BuildCustomizer

This class can be used to create and/or add custom builds to the queue. To create instance of the class use BuildCustomizerFactory

Since:

7.0

Method Summary

Modifier and Type	Method and Description
BuildPromotion	createPromotion() Creates build promotion with all custom settings.
SBuildType	getBuildType()
SUser	getCurrentUser()
void	setArtifactDependencies(java.util.List<SArtifactDependency> customDependencies) Sets custom artifact dependencies to the build.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Sets custom attributes to the build
void	setBuildComment(java.lang.String buildComment) Sets comment to the build.
void	setChangesUpTo(SVcsModification modification) Specifies the last change to include in this build.
void	setCleanSources(boolean cleanSources) If cleanSources is true the build will re-checkout all the sources on agent (note: this setting does not affect snapshot dependencies anyhow).
void	setDesiredBranchName(java.lang.String branchName) Sets the desired branch name for the build promotion (will be propagated to the whole snapshot dependency graph).
void	setParameters(java.util.Map<java.lang.String,java.lang.String> customParams) Sets custom parameters to the build, custom parameters will overwrite default parameters inherited from build configuration.
void	setPersonal(boolean personal) If personal is true the personal build will be created with owner set to user who performs the action.
void	setPersonalChangeId(long changeId) Sets id of a personal patch should be associated with the personal build.
void	setRebuildDependencies(boolean rebuild) Sets whether all snapshot dependencies must be rebuild or not.
void	setRebuildDependencies(java.util.Collection<java.lang.String> buildTypeIds) Specifies collection of build configurations where builds cannot be reused.
void	setSnapshotDependencyNodes(java.util.Collection<BuildPromotion> promotions) Sets custom nodes for the snapshot dependency graph.
void	setTagDatas(java.util.Set<TagData> tags) Sets build tags

Method Detail

getBuildType

@NotNull
SBuildType getBuildType()

Returns:

build configuration to which custom build belongs.

getCurrentUser

@Nullable
SUser getCurrentUser()

Returns:

user set to customizer during customizer instance creation.

setParameters

void setParameters(@NotNull
                   java.util.Map<java.lang.String,java.lang.String> customParams)

Sets custom parameters to the build, custom parameters will overwrite default parameters inherited from build configuration.

Parameters:

customParams - custom parameters map

setAttributes

void setAttributes(@NotNull
                   java.util.Map<java.lang.String,java.lang.String> attributes)

Sets custom attributes to the build

Parameters:

attributes - custom attributes map

setRebuildDependencies

void setRebuildDependencies(boolean rebuild)

Sets whether all snapshot dependencies must be rebuild or not. This is the same as to set option DependencyOptions.TAKE_STARTED_BUILD_WITH_SAME_REVISIONS to false for all snapshot dependencies.

Parameters:

rebuild - true to rebuild all dependencies

setRebuildDependencies

void setRebuildDependencies(@NotNull
                            java.util.Collection<java.lang.String> buildTypeIds)

Specifies collection of build configurations where builds cannot be reused. Similar to setRebuildDependencies(boolean) but works for a specific set of nodes. Note that setRebuildDependencies(boolean) (true) has higher priority.

Parameters:

buildTypeIds - ids of build configurations where builds reusing is disabled

setBuildComment

void setBuildComment(@NotNull
                     java.lang.String buildComment)

Sets comment to the build. If comment is specified but user was not set to this customizer IllegalArgumentException is thrown.

Parameters:

buildComment - comment to set

setChangesUpTo

void setChangesUpTo(@NotNull
                    SVcsModification modification)

Specifies the last change to include in this build.

Parameters:

modification - the last change to include in the build

setPersonal

void setPersonal(boolean personal)

If personal is true the personal build will be created with owner set to user who performs the action. If personal is true but user was not set to this customizer IllegalArgumentException is thrown.

Parameters:

personal - true for personal build, false otherwise

setPersonalChangeId

void setPersonalChangeId(long changeId)

Sets id of a personal patch should be associated with the personal build.

Parameters:

changeId - personal patch id

Since:

2019.1

setArtifactDependencies

void setArtifactDependencies(@NotNull
                             java.util.List<SArtifactDependency> customDependencies)

Sets custom artifact dependencies to the build. Custom dependencies will overwrite default dependencies completely.

Parameters:

customDependencies - collection of custom artifact dependencies

setSnapshotDependencyNodes

void setSnapshotDependencyNodes(@NotNull
                                java.util.Collection<BuildPromotion> promotions)

Sets custom nodes for the snapshot dependency graph. Each custom node will replace existing one for the same build configuration.

Parameters:

promotions - nodes to insert in the snapshot dependency graph

setCleanSources

void setCleanSources(boolean cleanSources)

If cleanSources is true the build will re-checkout all the sources on agent (note: this setting does not affect snapshot dependencies anyhow).

Parameters:

cleanSources - true to re-checkout sources on agent.

setDesiredBranchName

void setDesiredBranchName(@NotNull
                          java.lang.String branchName)

Sets the desired branch name for the build promotion (will be propagated to the whole snapshot dependency graph).

Parameters:

branchName - the branch name - empty string or display name of the default branch means default branch

Since:

7.1

createPromotion

@NotNull
BuildPromotion createPromotion()

Creates build promotion with all custom settings. Created build promotion can be added to the queue.

Returns:

new build promotion

Throws:

java.lang.RuntimeException - if some problem occurred

setTagDatas

void setTagDatas(@NotNull
                 java.util.Set<TagData> tags)

Sets build tags

Since:

9.0