Package jetbrains.buildServer.serverSide

Class AgentCompatibility

java.lang.Object

jetbrains.buildServer.serverSide.AgentCompatibility

All Implemented Interfaces:

CompatibilityResult

public class AgentCompatibility
extends Object
implements CompatibilityResult

Presents information about compatibility the given agent with the specified configuration.

Constructor Summary

Constructors

Constructor	Description
AgentCompatibility(AgentDescription agentDescription, SBuildType buildType, boolean isActive)	Creates new empty compatibility instance.
AgentCompatibility(CompatibilityResult compatibilityResult, AgentDescription agentDescription, SBuildType buildType, boolean isActive)	Create a new compatibility instance copying the existence yet calculated compatibility result.

Method Summary

Modifier and Type	Method	Description
AgentDescription	getAgentDescription()	Specified agent description.
SBuildType	getBuildType()	Specified configuration.
RunType	getIncompatibleRunner()	Returns incompatible runner (i.e.
List<InvalidProperty>	getInvalidRunParameters()	Returns invalid runner parameters list.
Map<String,String>	getMissedVcsPluginsOnAgent()	Returns map of VCS plugins required by build configuration which are not installed on the agent.
List<Requirement>	getNonMatchedRequirements()	Returns list of non matched requirements
Map<String,String>	getUndefinedParameters()	Returns map of undefined parameters (parameter references without actual values, i.e.
boolean	isActive()	Returns true if the specified agent (agent type) is in agent pool which is associated with the project of the specified build type
boolean	isCompatible()	Returns true if build configuration is compatible with agent
boolean	isSuitableRunnerExists()	Returns true if the specified agent has suitable runner for the configuration.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentCompatibility

public AgentCompatibility(@NotNull
                          AgentDescription agentDescription,
                          @NotNull
                          SBuildType buildType,
                          boolean isActive)

Creates new empty compatibility instance.

Parameters:

agentDescription - specified agent description.

buildType - specified configuration.

AgentCompatibility

public AgentCompatibility(@NotNull
                          CompatibilityResult compatibilityResult,
                          @NotNull
                          AgentDescription agentDescription,
                          @NotNull
                          SBuildType buildType,
                          boolean isActive)

Create a new compatibility instance copying the existence yet calculated compatibility result.

Parameters:

agentDescription - specified agent description.

buildType - specified configuration.

Method Detail

getAgentDescription

@NotNull
public AgentDescription getAgentDescription()

Specified agent description.

Returns:

the specified agent description.

getBuildType

@NotNull
public SBuildType getBuildType()

Specified configuration.

Returns:

the specified configuration.

isActive

public boolean isActive()

Returns true if the specified agent (agent type) is in agent pool which is associated with the project of the specified build type

Returns:

see above

isCompatible

public boolean isCompatible()

Description copied from interface: CompatibilityResult

Returns true if build configuration is compatible with agent

Specified by:

isCompatible in interface CompatibilityResult

Returns:

see above

isSuitableRunnerExists

public boolean isSuitableRunnerExists()

Description copied from interface: CompatibilityResult

Returns true if the specified agent has suitable runner for the configuration.

Specified by:

isSuitableRunnerExists in interface CompatibilityResult

Returns:

see above

getIncompatibleRunner

@Nullable
public RunType getIncompatibleRunner()

Description copied from interface: CompatibilityResult

Returns incompatible runner (i.e. runner is defined in build configuration settings but does not exist on agent)

Specified by:

getIncompatibleRunner in interface CompatibilityResult

Returns:

see above

getInvalidRunParameters

@NotNull
public List<InvalidProperty> getInvalidRunParameters()

Description copied from interface: CompatibilityResult

Returns invalid runner parameters list.

Specified by:

getInvalidRunParameters in interface CompatibilityResult

Returns:

see above

getNonMatchedRequirements

@NotNull
public List<Requirement> getNonMatchedRequirements()

Description copied from interface: CompatibilityResult

Returns list of non matched requirements

Specified by:

getNonMatchedRequirements in interface CompatibilityResult

Returns:

see above

getMissedVcsPluginsOnAgent

@NotNull
public Map<String,String> getMissedVcsPluginsOnAgent()

Description copied from interface: CompatibilityResult

Returns map of VCS plugins required by build configuration which are not installed on the agent. The key in the map is plugin name, the value is display name of the plugin (suitable for showing in the UI)

Specified by:

getMissedVcsPluginsOnAgent in interface CompatibilityResult

Returns:

see above

getUndefinedParameters

@NotNull
public Map<String,String> getUndefinedParameters()

Description copied from interface: CompatibilityResult

Returns map of undefined parameters (parameter references without actual values, i.e. so called implicit requirements).

Specified by:

getUndefinedParameters in interface CompatibilityResult

Returns:

map of parameter name to parameter origin - short description where reference to parameter is defined

toString

public String toString()

Overrides:

toString in class Object