jetbrains.buildServer.serverSide

Interface AgentDescription

All Known Subinterfaces:

SBuildAgent

public interface AgentDescription

Represents agent parameters required to check agent and build configuration compatibility

Since:

5.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAvailableParameters() Returns map of parameters available on the agent.
java.util.Set<java.lang.String>	getAvailableRunTypeIds() Returns set of runner types available on the agent
java.util.List<RunType>	getAvailableRunTypes() Returns list of runners available on the agent
java.util.List<java.lang.String>	getAvailableVcsPlugins()
java.util.Map<java.lang.String,java.lang.String>	getBuildParameters() Returns map of build parameters that will be added to the build parameters when build is started on the agent.
java.util.Map<java.lang.String,java.lang.String>	getConfigurationParameters() Returns map of configuration parameters that are defined on the build agent.
int	getCpuBenchmarkIndex() Returns this agent CPU benchmark index.
java.util.Map<java.lang.String,java.lang.String>	getDefinedParameters() Deprecated. Use getConfigurationParameters() or getBuildParameters(). This method returns merged map of both getConfigurationParameters() or getBuildParameters().
java.lang.String	getOperatingSystemName() Returns name of the operating system where the agent is currently running.
boolean	isCaseInsensitiveEnvironment()

Method Detail

getAvailableRunTypes

@NotNull
java.util.List<RunType> getAvailableRunTypes()

Returns list of runners available on the agent

Returns:

list of runners ordered by display name

Since:

5.0

getAvailableRunTypeIds

@NotNull
java.util.Set<java.lang.String> getAvailableRunTypeIds()

Returns set of runner types available on the agent

Returns:

set of runner types

Since:

2018.2

getAvailableVcsPlugins

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

getOperatingSystemName

@NotNull
java.lang.String getOperatingSystemName()

Returns name of the operating system where the agent is currently running.

Returns:

name of the operating system where the agent is currently running.

Since:

5.0

getCpuBenchmarkIndex

int getCpuBenchmarkIndex()

Returns this agent CPU benchmark index. The higher this value the more powerful agent CPU.

Returns:

CPU index or -1 if index is not available

Since:

5.0

getAvailableParameters

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

Returns map of parameters available on the agent. These parameters include environment variables defined for the agent process as well as parameters defined in the agent configuration file.

Returns:

see above

Since:

5.0

getDefinedParameters

@NotNull
 @Deprecated
java.util.Map<java.lang.String,java.lang.String> getDefinedParameters()

Deprecated. Use getConfigurationParameters() or getBuildParameters(). This method returns merged map of both getConfigurationParameters() or getBuildParameters().

Returns map of parameters explicitly defined in the agent configuration file.

Returns:

see above

Since:

5.0

getConfigurationParameters

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

Returns map of configuration parameters that are defined on the build agent. Those parameters may be defined in agent configuration files or may be provided by agent plugins.

Returns:

map of parameters

Since:

6.0

getBuildParameters

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

Returns map of build parameters that will be added to the build parameters when build is started on the agent. Keys in the map have prefixes Constants.SYSTEM_PREFIX or Constants.ENV_PREFIX

Returns:

map of build parameters.

Since:

6.0

isCaseInsensitiveEnvironment

boolean isCaseInsensitiveEnvironment()

Returns:

true if names of environment variables are case insensitive

Since:

6.5