BaseAgentType (javadoc 2024.12-174331 API)

All Superinterfaces:

Describable, ServerExtension, TeamCityExtension

All Known Subinterfaces:

BuildExecutorType, CloudClientFactory, CloudType

All Known Implementing Classes:

DummyCloudClientFactory, ReadonlyClientFactory
```
public interface BaseAgentType
extends Describable, ServerExtension
```
Represents the base for different types of sources for agents, such as cloud profiles or agents

Since:

2024.07

See Also:

BuildExecutorType, CloudType

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getEditProfileUrl()`	Properties editor jsp
`Map<String,String>`	`getInitialParameterValues()`	Return initial values for form pareters.
`default String`	`getProfileIconUrl()`	Retrieves the URL of the icon for the given agent type
`PropertiesProcessor`	`getPropertiesProcessor()`	Returns the properties processor instance (validator).
`String`	`getType()`	Returns the type of the external agent.
`String`	`getTypeDescription()`

Methods inherited from interface jetbrains.buildServer.serverSide.Describable
getDisplayName

- Method Detail
  - getType
```
String getType()
```
    Returns the type of the external agent.
    This should be an uniqueable identifiable value for this type
    
    Returns:
    
    the type of the external agent
  - getEditProfileUrl
```
@Nullable
String getEditProfileUrl()
```
    Properties editor jsp
    
    Returns:
    
    properties editor JSP file
    
    Since:
    
    5.1
  - getInitialParameterValues
```
@NotNull
Map<String,String> getInitialParameterValues()
```
    Return initial values for form pareters.
    
    Returns:
    
    map of initial values
  - getPropertiesProcessor
```
@NotNull
PropertiesProcessor getPropertiesProcessor()
```
    Returns the properties processor instance (validator).
    
    Returns:
    
    properties processor
  - getProfileIconUrl
```
@NotNull
default String getProfileIconUrl()
```
    Retrieves the URL of the icon for the given agent type
    
    Returns:
    
    the URL of the icon
    
    Since:
    
    2024.07
  - getTypeDescription
```
@NotNull
String getTypeDescription()
```