CloudType (javadoc 2024.12-174331 API)

All Superinterfaces:

BaseAgentType, Describable, ServerExtension, TeamCityExtension

All Known Subinterfaces:

CloudClientFactory

All Known Implementing Classes:

DummyCloudClientFactory, ReadonlyClientFactory
```
public interface CloudType
extends Describable, BaseAgentType
```
Represents a client object to work with a cloud description.
The implementation is semantically stateless.

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`canBeAgentOfType(AgentDescription description)`	Checks it the agent could be an instance of one of the running profiles.
`String`	`getCloudCode()`	The formal name of the cloud type.
`String`	`getDisplayName()`	Description to be shown on the web pages
`default String`	`getType()`	Returns the type of the external agent.
`default String`	`getTypeDescription()`

Methods inherited from interface jetbrains.buildServer.clouds.BaseAgentType
getEditProfileUrl, getInitialParameterValues, getProfileIconUrl, getPropertiesProcessor

- Method Detail
  - getType
```
default String getType()
```
    Description copied from interface: BaseAgentType
    
    Returns the type of the external agent.
    This should be an uniqueable identifiable value for this type
    
    Specified by:
    
    getType in interface BaseAgentType
    
    Returns:
    
    the type of the external agent
  - getCloudCode
```
@NotNull
String getCloudCode()
```
    The formal name of the cloud type. This is used to identify cloud implementations inside.
    
    Returns:
    
    cloud name
  - getDisplayName
```
@NotNull
String getDisplayName()
```
    Description to be shown on the web pages
    
    Specified by:
    
    getDisplayName in interface Describable
    
    Returns:
    
    display name to be shown to the user
  - canBeAgentOfType
```
boolean canBeAgentOfType(@NotNull
                         AgentDescription description)
```
    Checks it the agent could be an instance of one of the running profiles. This method is called to check weather it is needed to open connection for a cloud profiles of that type to check if the agent is started from a cloud profiles of that type.
    
    Parameters:
    
    description - agent info to check
    
    Returns:
    
    true if this agent could be an instance of that cloud type
  - getTypeDescription
```
@NotNull
default String getTypeDescription()
```
    Specified by:
    
    getTypeDescription in interface BaseAgentType