jetbrains.buildServer.agentServer

Class AgentBuild

java.lang.Object

jetbrains.buildServer.agentServer.AgentBuild

All Implemented Interfaces:

jetbrains.buildServer.log.Loggable

public class AgentBuild
extends java.lang.Object
implements jetbrains.buildServer.log.Loggable

Contains necessary information about build to start on an agent. Used to transfer this information from server to agent when build starts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentBuild.CheckoutType

Constructor Summary

Constructors

Constructor and Description
AgentBuild(long buildId)

Method Summary

Modifier and Type	Method and Description
void	addFullCheckoutReason(java.lang.String reason)
java.lang.String	describe(boolean verbose)
static AgentBuild	deserialize(java.lang.String serialized)
java.lang.String	getAccessCode()
java.lang.String	getAccessUser()
java.util.List<ArtifactDependencyInfo>	getArtifactDependencies()
java.lang.String	getArtifactPaths()
java.util.Map<java.lang.String,java.lang.String>	getArtifactStorageSettings()
java.util.List<BuildFeatureInfo>	getBuildFeatures()
long	getBuildId()
java.util.List<BuildRunnerData>	getBuildRunners()
java.lang.String	getBuildTypeExternalId()
java.lang.String	getBuildTypeId()
java.lang.String	getCheckoutDirectory()
AgentBuild.CheckoutType	getCheckoutType()
long	getCleanCheckoutEnforcedBuildId()
java.lang.String	getCurrentRevision(VcsRoot vcsRoot)
int	getDefaultExecutionTimeout()
java.util.List<java.lang.String>	getFullCheckoutReasons()
<T> T	getOptionValue(Option<T> option)
java.util.Map<java.lang.String,java.lang.String>	getParametersSpecMap() Returns a map of parameters spec strings.
java.util.List<VcsChangeInfo>	getPersonalVcsChanges() Returns list of VCS changed files affected by personal modification.
java.lang.String	getPreviousRevision(VcsRoot vcsRoot) Deprecated. use agent revision information from jetbrains.buildServer.agent.impl.vcs.AgentWorkDirRevisionManager instead
java.util.List<java.lang.String>	getRequiredTools()
java.util.Map<java.lang.String,java.lang.String>	getServerParameters() Returns map of parameters defined on the server side.
java.util.List<java.lang.String>	getUserBuildParameters()
java.util.Collection<java.lang.String>	getUserDefinedReferences()
java.util.List<VcsChangeInfo>	getVcsChanges() Returns list of VCS changed files affected by non personal modifications.
java.util.List<VcsRootEntry>	getVcsRootEntries()
java.lang.String	getVcsSettingsHashForAgentCheckout()
java.lang.String	getVcsSettingsHashForManualCheckout()
java.lang.String	getVcsSettingsHashForServerCheckout()
boolean	isPersonal()
boolean	isPersonalPatchAvailable()
java.lang.String	serialize()
void	setAccessCode(java.lang.String accessCode)
void	setArtifactDependencies(java.util.List<ArtifactDependencyInfo> artifactDependencies)
void	setArtifactPaths(java.lang.String artifactPaths)
void	setArtifactStorageSettings(java.util.Map<java.lang.String,java.lang.String> storageSettings)
void	setBuildFeatures(java.util.List<BuildFeatureInfo> infos)
void	setBuildRunners(java.util.List<BuildRunnerData> settings)
void	setBuildTypeExternalId(java.lang.String buildTypeExternalId)
void	setBuildTypeId(java.lang.String buildTypeId)
void	setBuildTypeOptions(java.util.Map<Option,java.lang.Object> options)
void	setCheckoutDirectory(java.lang.String checkoutDirectory)
void	setCheckoutType(AgentBuild.CheckoutType checkoutType)
void	setCleanCheckoutEnforcedBuildId(long cleanCheckoutEnforcedBuildId)
void	setCurrentRevision(long vcsRootId, java.lang.String currentRevision)
void	setDefaultCheckoutDirectory(java.lang.String defaultDirNameRelativeToWorkingDir) Deprecated. since 10.0
void	setDefaultExecutionTimeout(int executionTimeout)
void	setParametersSpecMap(java.util.Map<java.lang.String,java.lang.String> parametersSpecs)
void	setPersonal(boolean personal)
void	setPersonalPatchAvailable(boolean personalPatchAvailable)
void	setPersonalVcsChanges(java.util.List<VcsChangeInfo> vcsChanges)
void	setPreviousRevision(long vcsRootId, java.lang.String oldRevision) Deprecated. use agent revision information from jetbrains.buildServer.agent.impl.vcs.AgentWorkDirRevisionManager instead
void	setRequiredTools(java.util.Collection<java.lang.String> requiredTools)
void	setServerParameters(java.util.Map<java.lang.String,java.lang.String> serverParameters)
void	setUserBuildParameters(java.util.Collection<java.lang.String> userDefinedKeys)
void	setVcsChanges(java.util.List<VcsChangeInfo> vcsChanges)
void	setVcsRootEntries(java.util.List<? extends VcsRootEntry> vcsRootEntries)
void	setVcsSettingsHashForAgentCheckout(java.lang.String defaultDirNameRelativeToWorkingDir)
void	setVcsSettingsHashForManualCheckout(java.lang.String defaultDirNameRelativeToWorkingDir)
void	setVcsSettingsHashForServerCheckout(java.lang.String defaultDirNameRelativeToWorkingDir)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AgentBuild

public AgentBuild(long buildId)

Method Detail

getBuildId

public long getBuildId()

getBuildTypeId

@NotNull
public java.lang.String getBuildTypeId()

setBuildTypeId

public void setBuildTypeId(@NotNull
                           java.lang.String buildTypeId)

getBuildTypeExternalId

@NotNull
public java.lang.String getBuildTypeExternalId()

setBuildTypeExternalId

public void setBuildTypeExternalId(@NotNull
                                   java.lang.String buildTypeExternalId)

setCheckoutDirectory

public void setCheckoutDirectory(@Nullable
                                 java.lang.String checkoutDirectory)

setArtifactPaths

public void setArtifactPaths(java.lang.String artifactPaths)

getArtifactPaths

@Nullable
public java.lang.String getArtifactPaths()

isPersonal

public boolean isPersonal()

isPersonalPatchAvailable

public boolean isPersonalPatchAvailable()

setPersonal

public void setPersonal(boolean personal)

setPersonalPatchAvailable

public void setPersonalPatchAvailable(boolean personalPatchAvailable)

setBuildTypeOptions

public void setBuildTypeOptions(@NotNull
                                java.util.Map<Option,java.lang.Object> options)

getCleanCheckoutEnforcedBuildId

public long getCleanCheckoutEnforcedBuildId()

setCleanCheckoutEnforcedBuildId

public void setCleanCheckoutEnforcedBuildId(long cleanCheckoutEnforcedBuildId)

setDefaultExecutionTimeout

public void setDefaultExecutionTimeout(int executionTimeout)

getDefaultExecutionTimeout

public int getDefaultExecutionTimeout()

getAccessUser

@NotNull
public java.lang.String getAccessUser()

getAccessCode

@NotNull
public java.lang.String getAccessCode()

setAccessCode

public void setAccessCode(@NotNull
                          java.lang.String accessCode)

getCheckoutType

@NotNull
public AgentBuild.CheckoutType getCheckoutType()

setCheckoutType

public void setCheckoutType(@NotNull
                            AgentBuild.CheckoutType checkoutType)

getServerParameters

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getServerParameters()

Returns map of parameters defined on the server side. The map includes prefixed (system., env.) and configuration parameters (without prefix). System. and env. parameters will be sent to a build, while configuration parameters can only be used in references resolving.

Returns:

see above

setServerParameters

public void setServerParameters(@NotNull
                                java.util.Map<java.lang.String,java.lang.String> serverParameters)

setParametersSpecMap

public void setParametersSpecMap(java.util.Map<java.lang.String,java.lang.String> parametersSpecs)

setRequiredTools

public void setRequiredTools(java.util.Collection<java.lang.String> requiredTools)

getRequiredTools

public java.util.List<java.lang.String> getRequiredTools()

getParametersSpecMap

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getParametersSpecMap()

Returns a map of parameters spec strings. ParametersUtil could be used to create ControlDescription instance from a string. Specs should not change during the build. The map contain only those parameter keys which have a spec.

getVcsRootEntries

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

setVcsRootEntries

public void setVcsRootEntries(@NotNull
                              java.util.List<? extends VcsRootEntry> vcsRootEntries)

getPreviousRevision

@Deprecated
 @Nullable
public java.lang.String getPreviousRevision(@NotNull
                                                                   VcsRoot vcsRoot)

Deprecated. use agent revision information from jetbrains.buildServer.agent.impl.vcs.AgentWorkDirRevisionManager instead

setPreviousRevision

@Deprecated
public void setPreviousRevision(long vcsRootId,
                                            @Nullable
                                            java.lang.String oldRevision)

Deprecated. use agent revision information from jetbrains.buildServer.agent.impl.vcs.AgentWorkDirRevisionManager instead

getCurrentRevision

@Nullable
public java.lang.String getCurrentRevision(@NotNull
                                                     VcsRoot vcsRoot)

setCurrentRevision

public void setCurrentRevision(long vcsRootId,
                               @Nullable
                               java.lang.String currentRevision)

getFullCheckoutReasons

@NotNull
public java.util.List<java.lang.String> getFullCheckoutReasons()

addFullCheckoutReason

public void addFullCheckoutReason(@NotNull
                                  java.lang.String reason)

getArtifactDependencies

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

setArtifactDependencies

public void setArtifactDependencies(@NotNull
                                    java.util.List<ArtifactDependencyInfo> artifactDependencies)

setDefaultCheckoutDirectory

@Deprecated
public void setDefaultCheckoutDirectory(@NotNull
                                                    java.lang.String defaultDirNameRelativeToWorkingDir)

Deprecated. since 10.0

setVcsSettingsHashForAgentCheckout

public void setVcsSettingsHashForAgentCheckout(@NotNull
                                               java.lang.String defaultDirNameRelativeToWorkingDir)

setVcsSettingsHashForServerCheckout

public void setVcsSettingsHashForServerCheckout(@NotNull
                                                java.lang.String defaultDirNameRelativeToWorkingDir)

setVcsSettingsHashForManualCheckout

public void setVcsSettingsHashForManualCheckout(@NotNull
                                                java.lang.String defaultDirNameRelativeToWorkingDir)

getVcsSettingsHashForServerCheckout

@NotNull
public java.lang.String getVcsSettingsHashForServerCheckout()

getVcsSettingsHashForAgentCheckout

@NotNull
public java.lang.String getVcsSettingsHashForAgentCheckout()

getVcsSettingsHashForManualCheckout

@NotNull
public java.lang.String getVcsSettingsHashForManualCheckout()

getCheckoutDirectory

@Nullable
public java.lang.String getCheckoutDirectory()

getBuildRunners

@NotNull
public java.util.List<BuildRunnerData> getBuildRunners()

setBuildRunners

public void setBuildRunners(@NotNull
                            java.util.List<BuildRunnerData> settings)

getBuildFeatures

public java.util.List<BuildFeatureInfo> getBuildFeatures()

setBuildFeatures

public void setBuildFeatures(@NotNull
                             java.util.List<BuildFeatureInfo> infos)

getOptionValue

@Nullable
public <T> T getOptionValue(@NotNull
                                      Option<T> option)

getVcsChanges

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

Returns list of VCS changed files affected by non personal modifications.

Returns:

see above

setVcsChanges

public void setVcsChanges(@NotNull
                          java.util.List<VcsChangeInfo> vcsChanges)

setPersonalVcsChanges

public void setPersonalVcsChanges(@NotNull
                                  java.util.List<VcsChangeInfo> vcsChanges)

setUserBuildParameters

public void setUserBuildParameters(@NotNull
                                   java.util.Collection<java.lang.String> userDefinedKeys)

getUserBuildParameters

@NotNull
public java.util.List<java.lang.String> getUserBuildParameters()

getUserDefinedReferences

@NotNull
public java.util.Collection<java.lang.String> getUserDefinedReferences()

getArtifactStorageSettings

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getArtifactStorageSettings()

setArtifactStorageSettings

public void setArtifactStorageSettings(@NotNull
                                       java.util.Map<java.lang.String,java.lang.String> storageSettings)

getPersonalVcsChanges

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

Returns list of VCS changed files affected by personal modification.

Returns:

see above

serialize

@NotNull
public java.lang.String serialize()

deserialize

@NotNull
public static AgentBuild deserialize(@NotNull
                                              java.lang.String serialized)

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describe

@NotNull
public java.lang.String describe(boolean verbose)

Specified by:

describe in interface jetbrains.buildServer.log.Loggable