StartingBuildAgentsFilter (javadoc 2024.12-174331 API)

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

BuildStartFilter, DefaultAgentsFilter, PriorityAgentsFilter, RunOnTheSameAgentFilter
```
public interface StartingBuildAgentsFilter
extends ServerExtension
```
This extension can filter agents for a queued build which is going to start. The extension can affect the order of agents and also can block build startup. In the latter case a WaitReason must be provided (the reason will be shown in the user interface).

Since:

6.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AgentsFilterResult`	`filterAgents(AgentsFilterContext context)`	Filters agents according to current filtering context.

- Method Detail
  - filterAgents
```
@NotNull
AgentsFilterResult filterAgents(@NotNull
                                AgentsFilterContext context)
```
    Filters agents according to current filtering context.
    
    Parameters:
    
    context - filtering context - contains information which might be used during the filtering
    
    Returns:
    
    result of the filtering