Package jetbrains.buildServer.serverSide.agentTypes

Class AgentTypeProperties

java.lang.Object

jetbrains.buildServer.serverSide.agentTypes.AgentDescriptionBase

jetbrains.buildServer.serverSide.agentTypes.AgentTypeProperties

All Implemented Interfaces:

AgentDescription, MutableAgentDescription

public final class AgentTypeProperties
extends AgentDescriptionBase
implements AgentDescription

Properties of agent type.

Value object.

Constructor Summary

Constructors

Constructor	Description
AgentTypeProperties(AgentTypeKey key, String operatingSystemName, int cpuBenchmarkIndex, Collection<RunType> availableRunTypes, Set<String> availableVcsPlugins, Map<String,String> buildParameters, Map<String,String> configParameters)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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.
AgentTypeKey	getKey()
String	getOperatingSystemName()	Returns name of the operating system where the agent is currently running.
int	hashCode()

Methods inherited from class jetbrains.buildServer.serverSide.agentTypes.AgentDescriptionBase

getAvailableParameters, getAvailableParameterValue, getCpuCount, getDefinedParameters, isCaseInsensitiveEnvironment, isCaseInsensitiveEnvironment, isEphemeral, updateParameters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.serverSide.AgentDescription

getAvailableParameters, getAvailableParameterValue, getCpuCount, getDefinedParameters, isCaseInsensitiveEnvironment

Constructor Detail

AgentTypeProperties

public AgentTypeProperties(@NotNull
                           AgentTypeKey key,
                           @NotNull
                           String operatingSystemName,
                           int cpuBenchmarkIndex,
                           @NotNull
                           Collection<RunType> availableRunTypes,
                           @NotNull
                           Set<String> availableVcsPlugins,
                           @NotNull
                           Map<String,String> buildParameters,
                           @NotNull
                           Map<String,String> configParameters)

Method Detail

getKey

@NotNull
public AgentTypeKey getKey()

getOperatingSystemName

@NotNull
public String getOperatingSystemName()

Description copied from interface: AgentDescription

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

Specified by:

getOperatingSystemName in interface AgentDescription

Returns:

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

getCpuBenchmarkIndex

public int getCpuBenchmarkIndex()

Description copied from interface: AgentDescription

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

Specified by:

getCpuBenchmarkIndex in interface AgentDescription

Returns:

CPU index or -1 if index is not available

getAvailableRunTypes

@NotNull
public List<RunType> getAvailableRunTypes()

Description copied from interface: AgentDescription

Returns list of runners available on the agent

Specified by:

getAvailableRunTypes in interface AgentDescription

Returns:

list of runners ordered by display name

getAvailableRunTypeIds

@NotNull
public Set<String> getAvailableRunTypeIds()

Description copied from interface: AgentDescription

Returns set of runner types available on the agent

Specified by:

getAvailableRunTypeIds in interface AgentDescription

Returns:

set of runner types

getAvailableVcsPlugins

@NotNull
public List<String> getAvailableVcsPlugins()

Specified by:

getAvailableVcsPlugins in interface AgentDescription

getConfigurationParameters

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

Description copied from interface: AgentDescription

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.

Specified by:

getConfigurationParameters in interface AgentDescription

Overrides:

getConfigurationParameters in class AgentDescriptionBase

Returns:

map of parameters

getBuildParameters

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

Description copied from interface: AgentDescription

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

Specified by:

getBuildParameters in interface AgentDescription

Overrides:

getBuildParameters in class AgentDescriptionBase

Returns:

map of build parameters.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object