jetbrains.buildServer.agentServer
Class AgentBuild

java.lang.Object
  extended by jetbrains.buildServer.agentServer.AgentBuild

public class AgentBuild
extends java.lang.Object

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
static class AgentBuild.CheckoutType
           
 
Constructor Summary
AgentBuild(long buildId)
           
 
Method Summary
static AgentBuild deserialize(java.lang.String serialized)
           
 java.lang.String getAccessCode()
           
 java.util.List<ArtifactDependencyInfo> getArtifactDependencies()
           
 java.lang.String getArtifactPaths()
           
 java.util.List<BuildFeatureInfo> getBuildFeatures()
           
 long getBuildId()
           
 java.util.List<BuildRunnerData> getBuildRunners()
           
 java.lang.String getBuildTypeId()
           
 java.lang.String getCheckoutDirectory()
           
 AgentBuild.CheckoutType getCheckoutType()
           
 java.lang.String getCurrentRevision(VcsRoot vcsRoot)
           
 java.lang.String getDefaultCheckoutDirectory()
           
 int getDefaultExecutionTimeout()
           
 java.lang.String getFullCheckoutReason(VcsRoot vcsRoot)
           
<T> T
getOptionValue(Option<T> option)
           
 java.util.List<VcsChangeInfo> getPersonalVcsChanges()
          Returns list of VCS changed files affected by personal modification.
 java.lang.String getPreviousRevision(VcsRoot vcsRoot)
           
 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()
           
 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 setBuildFeatures(java.util.List<BuildFeatureInfo> infos)
           
 void setBuildRunners(java.util.List<BuildRunnerData> settings)
           
 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 setCurrentRevision(long vcsRootId, java.lang.String currentRevision)
           
 void setDefaultCheckoutDirectory(java.lang.String defaultDirNameRelativeToWorkingDir)
           
 void setDefaultExecutionTimeout(int executionTimeout)
           
 void setFullCheckoutReason(long vcsRootId, java.lang.String reason)
           
 void setPersonal(boolean personal)
           
 void setPersonalPatchAvailable(boolean personalPatchAvailable)
           
 void setPersonalVcsChanges(java.util.List<VcsChangeInfo> vcsChanges)
           
 void setPreviousRevision(long vcsRootId, java.lang.String oldRevision)
           
 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)
           
 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)

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)

setDefaultExecutionTimeout

public void setDefaultExecutionTimeout(int executionTimeout)

getDefaultExecutionTimeout

public int getDefaultExecutionTimeout()

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)

getVcsRootEntries

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

setVcsRootEntries

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

getPreviousRevision

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

setPreviousRevision

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

getCurrentRevision

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

setCurrentRevision

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

getFullCheckoutReason

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

setFullCheckoutReason

public void setFullCheckoutReason(long vcsRootId,
                                  @Nullable
                                  java.lang.String reason)

getArtifactDependencies

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

setArtifactDependencies

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

getDefaultCheckoutDirectory

@NotNull
public java.lang.String getDefaultCheckoutDirectory()

setDefaultCheckoutDirectory

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

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

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