AgentsFilterResult

java.lang.Object
- jetbrains.buildServer.serverSide.buildDistribution.AgentsFilterResult

```
public class AgentsFilterResult
extends java.lang.Object
```
Results of the agents filtering for a build which is going to start.

Since:

6.0

Constructor Summary

Constructors
Constructor Description

AgentsFilterResult()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<SBuildAgent>`	`getFilteredConnectedAgents()`	Returns list of filtered agents which can start a build.
`WaitReason`	`getWaitReason()`	Returns wait reason if build startup must be blocked or null if startup is allowed.
`void`	`setFilteredConnectedAgents(java.util.List<SBuildAgent> filteredConnectedAgents)`	Sets new list of agents to use for the starting build.
`void`	`setWaitReason(WaitReason waitReason)`	Sets wait reason.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AgentsFilterResult
```
public AgentsFilterResult()
```
- Method Detail
  - getWaitReason
```
@Nullable
public WaitReason getWaitReason()
```
    Returns wait reason if build startup must be blocked or null if startup is allowed. If wait reason is null, not empty collection of agents must be returned.
    
    Returns:
    
    wait reason or null
  - setWaitReason
```
public void setWaitReason(@Nullable
                          WaitReason waitReason)
```
    Sets wait reason.
    
    Parameters:
    
    waitReason - reason why build must not be started at the moment
  - getFilteredConnectedAgents
```
@Nullable
public java.util.List<SBuildAgent> getFilteredConnectedAgents()
```
    Returns list of filtered agents which can start a build. The order is significant: agents with lower index are more preferable. Null can be returned, in this case the agents collection and order are not affected.
    
    Returns:
    
    list of filtered agents which can start a build
  - setFilteredConnectedAgents
```
public void setFilteredConnectedAgents(@Nullable
                                       java.util.List<SBuildAgent> filteredConnectedAgents)
```
    Sets new list of agents to use for the starting build. Use null if agents must not be changed.
    
    Parameters:
    
    filteredConnectedAgents - the new list of agents for the starting build.