AgentParametersProvider (javadoc 2024.12-174331 API)

All Superinterfaces:

ServerExtension, TeamCityExtension
```
public interface AgentParametersProvider
extends ServerExtension
```
Author:

Sergey.Pak Date: 08.06.20

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canFetchParameters(AgentTypeKey agentTypeKey)`	Indicates whether it's possible to fetch parameters for the given agentTypeKey
`boolean`	`disableUpdateFromAgent(AgentTypeKey agentTypeKey)`	Indicates whether parameters are always provided by the extension and should never be updated from the agent.
`Future<AgentDescription>`	`fetchParametersAsync(AgentTypeKey agentTypeKey)`	this method should asynchronously call parameters fetcher
`long`	`getTimeoutMs()`	Maximum amount of time (in milliseconds) to wait for response

- Method Detail
  - canFetchParameters
```
boolean canFetchParameters(@NotNull
                           AgentTypeKey agentTypeKey)
```
    Indicates whether it's possible to fetch parameters for the given agentTypeKey
    
    Parameters:
    
    agentTypeKey - AgentTypeKey to fetch parameters for
    
    Returns:
    
    true if that extension can fetch parameters, false otherwise
  - disableUpdateFromAgent
```
boolean disableUpdateFromAgent(@NotNull
                               AgentTypeKey agentTypeKey)
```
    Indicates whether parameters are always provided by the extension and should never be updated from the agent. In this case plugin should take care of parameters update itself
    
    Parameters:
    
    agentTypeKey -
    
    Returns:
  - getTimeoutMs
```
long getTimeoutMs()
```
    Maximum amount of time (in milliseconds) to wait for response
    
    Returns:
    
    see above
  - fetchParametersAsync
```
@NotNull
Future<AgentDescription> fetchParametersAsync(@NotNull
                                              AgentTypeKey agentTypeKey)
```
    this method should asynchronously call parameters fetcher
    
    Parameters:
    
    agentTypeKey - key of agent type to fetch parameters for
    
    Returns:
    
    a Future containing map of parameters or null if plugin will update AgentType itself