All Known Subinterfaces:

AgentType, BuildAgentEx, MutableAgentDescription, SAgentType, SBuildAgent

All Known Implementing Classes:

AbstractBuildAgent, AbstractBuildAgentContext, AgentDescriptionBase, AgentDetailsDescription, AgentTypeData, AgentTypeImpl, AgentTypeProperties, DeadAgent, DeadAgentType, DummyAgentType, MockAgentDescription, MockAgentType, MockBuildAgent, MutableAgentDescriptionProxy, RegisteredAgent, SecuredAgentType, SecuredBuildAgent, UnknownAgentDescription, UnregisteredAgent, UnresolvedCloudAgentTypeData
```
public interface AgentDescription
```
Represents agent parameters required to check agent and build configuration compatibility

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getAvailableParameters()`	Returns map of parameters available on the agent.
`default String`	`getAvailableParameterValue(String parameterName)`	Returns value of a single available parameter.
`Set<String>`	`getAvailableRunTypeIds()`	Returns set of runner types available on the agent
`List<RunType>`	`getAvailableRunTypes()`	Returns list of runners available on the agent
`List<String>`	`getAvailableVcsPlugins()`
`Map<String,String>`	`getBuildParameters()`	Returns map of build parameters that will be added to the build parameters when build is started on the agent.
`Map<String,String>`	`getConfigurationParameters()`	Returns map of configuration parameters that are defined on the build agent.
`int`	`getCpuBenchmarkIndex()`	Returns this agent CPU benchmark index.
`int`	`getCpuCount()`	Returns the number of CPUs of this agent
`Map<String,String>`	`getDefinedParameters()`	Deprecated. Use `getConfigurationParameters()` or `getBuildParameters()`.
`String`	`getOperatingSystemName()`	Returns name of the operating system where the agent is currently running.
`boolean`	`isCaseInsensitiveEnvironment()`

- Method Detail
  - getAvailableRunTypes
```
@NotNull
List<RunType> getAvailableRunTypes()
```
    Returns list of runners available on the agent
    
    Returns:
    
    list of runners ordered by display name
    
    Since:
    
    5.0
  - getAvailableRunTypeIds
```
@NotNull
Set<String> getAvailableRunTypeIds()
```
    Returns set of runner types available on the agent
    
    Returns:
    
    set of runner types
    
    Since:
    
    2018.2
  - getAvailableVcsPlugins
```
@NotNull
List<String> getAvailableVcsPlugins()
```
  - getOperatingSystemName
```
@NotNull
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
Map<String,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
  - getAvailableParameterValue
```
@Nullable
default String getAvailableParameterValue(@NotNull
                                          String parameterName)
```
    Returns value of a single available parameter. This is equivalent to {@link #getAvailableParameters().get(name)} but can work faster.
    
    Parameters:
    
    parameterName - name of the parameter
    
    Returns:
    
    see above
    
    Since:
    
    2024.12
  - getDefinedParameters
```
@NotNull
@Deprecated
Map<String,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
Map<String,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
Map<String,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
  - getCpuCount
```
int getCpuCount()
```
    Returns the number of CPUs of this agent
    
    Returns:
    
    number of CPUs or -1 if count is not available
    
    Since:
    
    2023.03

Interface AgentDescription

Method Summary

Method Detail

getAvailableRunTypes

getAvailableRunTypeIds

getAvailableVcsPlugins

getOperatingSystemName

getCpuBenchmarkIndex

getAvailableParameters

getAvailableParameterValue

getDefinedParameters

getConfigurationParameters

getBuildParameters

isCaseInsensitiveEnvironment

getCpuCount