Interface AgentPool
-
- All Superinterfaces:
AgentPoolLimits
- All Known Subinterfaces:
ReadOnlyAgentPool
- All Known Implementing Classes:
AgentPoolImpl
,DummyAgentType.DummyAgentPool
,FakeAgentPool
,ProjectAgentPoolImpl
public interface AgentPool extends AgentPoolLimits
Represents agent pool
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_POOL_ID
static String
DEFAULT_POOL_NAME
static int
PROJECT_POOL_PLACEHOLDER
static int
UNASSIGNED_POOL_PLACEHOLDER
-
Fields inherited from interface jetbrains.buildServer.serverSide.agentPools.AgentPoolLimits
DEFAULT, UNLIMITED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
containsProjectId(String projectId)
indicates whether current pools contain this projectId.int
getAgentPoolId()
Collection<Integer>
getAgentTypeIds()
String
getName()
default String
getOwnerProjectId()
Collection<String>
getProjectIds()
Collection<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
-
UNASSIGNED_POOL_PLACEHOLDER
static final int UNASSIGNED_POOL_PLACEHOLDER
- See Also:
- Constant Field Values
-
DEFAULT_POOL_NAME
static final 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 String getName()
- Returns:
- agent pool name
-
getProjectIds
@NotNull Collection<String> getProjectIds()
- Returns:
- collection of projectIds associated with this pool. Only projectIds loaded into project model are returned
- Since:
- 10.0
-
getProjectIds
@NotNull Collection<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 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 Collection<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
-
getOwnerProjectId
@Nullable default String getOwnerProjectId()
- Returns:
- for a project pool returns an internal id of a project which is the owner of the pool, for a non project pool returns null
- Since:
- 2023.05.1
-
-