StartableAgent (javadoc 2024.12-174331 API)

All Superinterfaces:

VirtualAgent

All Known Implementing Classes:

StartableAgentImpl
```
public interface StartableAgent
extends VirtualAgent
```
Descripbes startable agent instance.

Author:

Eugene Petrenko

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Interface Description
  
  static class StartableAgent.Reason
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  boolean canStart()
  
  void startAgent(StartableAgent.Reason reason)
  Starts that agent
  - Methods inherited from interface jetbrains.buildServer.serverSide.impl.virtualAgent.VirtualAgent
    getAgentType, getStartableAgentType, hasConnectedAgents, hasRunningBuilds, isDisabled

- Method Detail
  - startAgent
```
void startAgent(@NotNull
                StartableAgent.Reason reason)
         throws StartAgentQuotaExceededException
```
    Starts that agent
    
    Parameters:
    
    reason - reason of starting the instance
    
    Throws:
    
    StartAgentQuotaExceededException - if start is not allowed due to the quota
  - canStart
```
boolean canStart()
```
    Returns:
    
    true if this agent can be started
    
    Since:
    
    10.0