jetbrains.buildServer.serverSide
Interface CompatibilityResult

All Known Implementing Classes:
AgentCompatibility, Compatibility

public interface CompatibilityResult

Represents result of the compatibility between a build configuration and an agent


Method Summary
 RunType getIncompatibleRunner()
          Returns incompatible runner (i.e.
 java.util.List<InvalidProperty> getInvalidRunParameters()
          Returns invalid runner parameters list.
 java.util.Map<java.lang.String,java.lang.String> getMissedVcsPluginsOnAgent()
          Returns map of VCS plugins required by build configuration which are not installed on the agent.
 java.util.List<Requirement> getNonMatchedRequirements()
          Returns list of non matched requirements
 java.util.Map<java.lang.String,java.lang.String> getUndefinedParameters()
          Returns map of undefined parameters (parameter references without actual values, i.e.
 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.
 

Method Detail

isCompatible

boolean isCompatible()
Returns true if build configuration is compatible with agent

Returns:
see above

isSuitableRunnerExists

boolean isSuitableRunnerExists()
Returns true if the specified agent has suitable runner for the configuration.

Returns:
see above

getIncompatibleRunner

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

Returns:
see above

getInvalidRunParameters

@NotNull
java.util.List<InvalidProperty> getInvalidRunParameters()
Returns invalid runner parameters list.

Returns:
see above

getNonMatchedRequirements

@NotNull
java.util.List<Requirement> getNonMatchedRequirements()
Returns list of non matched requirements

Returns:
see above

getMissedVcsPluginsOnAgent

@NotNull
java.util.Map<java.lang.String,java.lang.String> getMissedVcsPluginsOnAgent()
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)

Returns:
see above

getUndefinedParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getUndefinedParameters()
Returns map of undefined parameters (parameter references without actual values, i.e. so called implicit requirements).

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