jetbrains.buildServer.serverSide.agentPools

Interface AgentPool

All Superinterfaces:

AgentPoolLimits

public interface AgentPool
extends AgentPoolLimits

Represents agent pool

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POOL_ID
static java.lang.String	DEFAULT_POOL_NAME
static int	PROJECT_POOL_PLACEHOLDER

Fields inherited from interface jetbrains.buildServer.serverSide.agentPools.AgentPoolLimits

DEFAULT, UNLIMITED

Method Summary

Modifier and Type	Method and Description
boolean	containsProjectId(java.lang.String projectId) indicates whether current pools contain this projectId.
int	getAgentPoolId()
java.util.Collection<java.lang.Integer>	getAgentTypeIds()
java.lang.String	getName()
java.util.Collection<java.lang.String>	getProjectIds()
java.util.Collection<java.lang.String>	getProjectIds(boolean includeNonExisting)
boolean	isDefault()
boolean	isProjectPool()

Methods inherited from interface jetbrains.buildServer.serverSide.agentPools.AgentPoolLimits

getMaxAgents, getMinAgents

Field Detail

DEFAULT_POOL_ID

static final int DEFAULT_POOL_ID

See Also:

Constant Field Values

PROJECT_POOL_PLACEHOLDER

static final int PROJECT_POOL_PLACEHOLDER

See Also:

Constant Field Values

DEFAULT_POOL_NAME

static final java.lang.String DEFAULT_POOL_NAME

See Also:

Constant Field Values

Method Detail

getAgentPoolId

int getAgentPoolId()

Returns:

agent pool id

isDefault

boolean isDefault()

Returns:

true if agent pool is default

getName

@NotNull
java.lang.String getName()

Returns:

agent pool name

getProjectIds

@NotNull
java.util.Collection<java.lang.String> getProjectIds()

Returns:

collection of projectIds associated with this pool. Only projectIds loaded into project model are returned

Since:

10.0

getProjectIds

@NotNull
java.util.Collection<java.lang.String> getProjectIds(boolean includeNonExisting)

Parameters:

includeNonExisting - whether to include non-existing projectIds into result

Returns:

collection of projectIds associated with this pool. Only projectIds loaded into project model are returned

Since:

2017.2.4

containsProjectId

boolean containsProjectId(@NotNull
                          java.lang.String projectId)

indicates whether current pools contain this projectId. This method checks against DB data, not against current project model

Returns:

see above

Since:

2018.1

getAgentTypeIds

@NotNull
java.util.Collection<java.lang.Integer> getAgentTypeIds()

Returns:

collection of agent type ids associated with this pool

Since:

10.0

isProjectPool

boolean isProjectPool()

Returns:

indicates whether this agent pool is virtual (i.e. not persisted to DB)

Since:

2017.1