Package jetbrains.buildServer

Interface BuildAgent

All Known Subinterfaces:

BuildAgentEx, SBuildAgent

All Known Implementing Classes:

AbstractBuildAgent, AbstractBuildAgentContext, DeadAgent, MockBuildAgent, RegisteredAgent, SecuredBuildAgent, UnregisteredAgent

public interface BuildAgent

Representation of registered agent

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_POOL_ID	Deprecated. use AgentPool.DEFAULT_POOL_ID instead
static String	DEFAULT_POOL_NAME	Deprecated. use AgentPool.DEFAULT_POOL_NAME instead

Method Summary

Modifier and Type	Method	Description
int	getAgentPoolId()	Returns the pool id the agent belongs to.
int	getCpuBenchmarkIndex()	Returns this agent CPU benchmark index.
int	getCpuCount()	Returns the number of CPUs of this agent
int	getId()	Returns this agent unique id
String	getName()	Returns name of the agent
boolean	isEnabled()	Returns true if agent is enabled and false otherwise
boolean	isUpgrading()	Returns true if agent is upgrading

Field Detail

DEFAULT_POOL_ID

@Deprecated
static final int DEFAULT_POOL_ID

Deprecated.

use AgentPool.DEFAULT_POOL_ID instead

See Also:

Constant Field Values

DEFAULT_POOL_NAME

@Deprecated
static final String DEFAULT_POOL_NAME

Deprecated.

use AgentPool.DEFAULT_POOL_NAME instead

See Also:

Constant Field Values

Method Detail

getId

int getId()

Returns this agent unique id

Returns:

agent unique id

getName

String getName()

Returns name of the agent

Returns:

name of the agent

isUpgrading

boolean isUpgrading()

Returns true if agent is upgrading

Returns:

true if agent is upgrading

isEnabled

boolean isEnabled()

Returns true if agent is enabled and false otherwise

Returns:

true if agent is enabled and false otherwise

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

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

getAgentPoolId

int getAgentPoolId()

Returns the pool id the agent belongs to.

Returns:

agent pool id the agent belongs to

Since:

10.0