jetbrains.buildServer.agent
Interface AgentBuildSettings

All Known Subinterfaces:

AgentBuildInfo, AgentRunningBuild

public interface AgentBuildSettings

Since:

6.0

Author:

Eugene Petrenko

Method Summary

java.lang.String	getAccessCode() Returns build access code used to download artifacts
BuildAgentConfiguration	getAgentConfiguration() Build agent configuration of the build agent.
java.io.File	getAgentTempDirectory() Returns temporary directory which is cleaned before the build is started.
java.util.List<ArtifactDependencyInfo>	getArtifactDependencies() Returns artifact dependencies
java.lang.String	getBuildCurrentVersion(VcsRoot vcsRoot) Returns current version of the specified VCS root
long	getBuildId() Returns id of the build
BuildProgressLogger	getBuildLogger() Returns logger which can be used to log messages to the build log on server.
java.lang.String	getBuildPreviousVersion(VcsRoot vcsRoot) Returns previous version of the specified VCS root
java.io.File	getBuildTempDirectory() Returns build temporary directory.
java.lang.String	getBuildTypeId() Returns build configuration id
java.lang.String	getBuildTypeName() Returns name of build configuration (on the moment of build starting)
<T> T	getBuildTypeOptionValue(Option<T> option) Returns value of the specified build configuration option
java.io.File	getDefaultCheckoutDirectory()
long	getExecutionTimeoutMinutes() Returns build execution timeout in minutes, 0 indicates that there is no limit
java.util.List<VcsChangeInfo>	getPersonalVcsChanges() Returns list of changed files modified in personal changelist (if build is non personal returns empty list)
java.lang.String	getProjectName() Returns name of the project (on the moment of build starting)
java.util.List<VcsChangeInfo>	getVcsChanges() Returns list of changed files in this build (excluding files modified in personal changelist if build is personal)
java.util.List<VcsRootEntry>	getVcsRootEntries() Returns VCS root entries associated with this build, i.e.
boolean	isCheckoutOnAgent() Returns true if checkout is performed on the agent side
boolean	isCheckoutOnServer() Returns true if checkout is performed on the server side
boolean	isCleanBuild() Returns true if files should be cleaned before build
boolean	isCustomCheckoutDirectory() Returns true if custom checkout directory is specified.
boolean	isPersonal() Returns true if build is personal
boolean	isPersonalPatchAvailable()

Method Detail

getProjectName

java.lang.String getProjectName()

Returns name of the project (on the moment of build starting)

Returns:

name of the project

Since:

4.0

getBuildTypeId

@NotNull
java.lang.String getBuildTypeId()

Returns build configuration id

Returns:

build configuration id

Since:

4.0

getBuildTypeName

java.lang.String getBuildTypeName()

Returns name of build configuration (on the moment of build starting)

Returns:

name of build configuration

Since:

4.0

getBuildId

long getBuildId()

Returns id of the build

Returns:

build id

Since:

4.0

isCleanBuild

boolean isCleanBuild()

Returns true if files should be cleaned before build

Returns:

see above

Since:

4.0

isPersonal

boolean isPersonal()

Returns true if build is personal

Returns:

see above

Since:

4.0

isPersonalPatchAvailable

boolean isPersonalPatchAvailable()

Returns:

true if this personal build has personal patch.

Since:

6.5

isCheckoutOnAgent

boolean isCheckoutOnAgent()

Returns true if checkout is performed on the agent side

Returns:

see above

Since:

4.0

isCheckoutOnServer

boolean isCheckoutOnServer()

Returns true if checkout is performed on the server side

Returns:

see above

Since:

4.0

getExecutionTimeoutMinutes

long getExecutionTimeoutMinutes()

Returns build execution timeout in minutes, 0 indicates that there is no limit

Returns:

build execution timeout

Since:

4.0

getArtifactDependencies

@NotNull
java.util.List<ArtifactDependencyInfo> getArtifactDependencies()

Returns artifact dependencies

Returns:

artifact dependencies

Since:

4.0

getAccessCode

@NotNull
java.lang.String getAccessCode()

Returns build access code used to download artifacts

Returns:

build access code

Since:

4.0

getVcsRootEntries

@NotNull
java.util.List<VcsRootEntry> getVcsRootEntries()

Returns VCS root entries associated with this build, i.e. build configuration VCS root entries on the moment of build starting.

Returns:

see above

Since:

4.0

getBuildCurrentVersion

java.lang.String getBuildCurrentVersion(@NotNull
                                        VcsRoot vcsRoot)

Returns current version of the specified VCS root

Parameters:

vcsRoot - VCS root

Returns:

see above

Since:

4.0

getBuildPreviousVersion

java.lang.String getBuildPreviousVersion(@NotNull
                                         VcsRoot vcsRoot)

Returns previous version of the specified VCS root

Parameters:

vcsRoot - VCS root

Returns:

see above

Since:

4.0

isCustomCheckoutDirectory

boolean isCustomCheckoutDirectory()

Returns true if custom checkout directory is specified.

Returns:

true if custom checkout directory is specified

Since:

4.0

getVcsChanges

@NotNull
java.util.List<VcsChangeInfo> getVcsChanges()

Returns list of changed files in this build (excluding files modified in personal changelist if build is personal)

Returns:

list of changed files in this build (excluding personal changes)

Since:

4.0

getPersonalVcsChanges

@NotNull
java.util.List<VcsChangeInfo> getPersonalVcsChanges()

Returns list of changed files modified in personal changelist (if build is non personal returns empty list)

Returns:

list of changed files modified in personal changelist

Since:

4.0

getBuildTempDirectory

@NotNull
java.io.File getBuildTempDirectory()

Returns build temporary directory. This directory is cleaned before build is started. It is intended to be set as temporary folder for running build process. In general build process may do whateven it need with this directory contents. Consider using getAgentTempDirectory() to store temporary files that are created by any build running code on the build agent.

Returns:

build temp dir

Since:

4.0

getAgentTempDirectory

@NotNull
java.io.File getAgentTempDirectory()

Returns temporary directory which is cleaned before the build is started. This directory is intended to be used to store any build-agent related files that are needed to run the build. This folder is not intended to be used as build process temp directory.

Returns:

see above

Since:

4.0

getBuildLogger

@NotNull
BuildProgressLogger getBuildLogger()

Returns logger which can be used to log messages to the build log on server.

Returns:

logger for various build messages

Since:

4.0

getAgentConfiguration

@NotNull
BuildAgentConfiguration getAgentConfiguration()

Build agent configuration of the build agent.

Returns:

build agent configuration of the build agent

Since:

4.0

getBuildTypeOptionValue

<T> T getBuildTypeOptionValue(@NotNull
                              Option<T> option)

Returns value of the specified build configuration option

Type Parameters:

T - type of the value

Parameters:

option - build configuration option

Returns:

value

Since:

4.5

getDefaultCheckoutDirectory

@NotNull
java.io.File getDefaultCheckoutDirectory()

Returns:

default checkout directory which will be used if custom checkout directory is not specified.

Since:

7.0