Package com.atlassian.bamboo.agent.ephemeral

Interface EphemeralAgentsService

All Known Implementing Classes:

EphemeralAgentsServiceImpl

@PublicApi
public interface EphemeralAgentsService

Since:

9.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EphemeralAgentsService.DuplicateTemplateNameException

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateCapability(@NotNull EphemeralAgentTemplate template, @NotNull Capability capability)
@NotNull EphemeralAgentTemplate	copyEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Copies specified Ephemeral Agent Template and saves it within the persistence layer.
void	deleteEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Deletes specified Ephemeral Agent Template from the persistence layer.
EphemeralAgentsConfiguration	getEphemeralAgentsBaseConfiguration()
@NotNull Optional<EphemeralAgentTemplate>	getEphemeralAgentTemplate(long id)	Gets the Ephemeral Agent Template for the requested ID if the one exist.
@NotNull List<EphemeralAgentTemplate>	getEphemeralAgentTemplates()	Gets all available Ephemeral Agent Templates.
@NotNull List<EphemeralAgentTemplate>	getEphemeralAgentTemplates(@Nullable String filter, int start, int limit)	Gets list of Ephemeral Agent Templates filtered.
boolean	isEphemeralAgentsEnabled()
void	removeCapability(@NotNull EphemeralAgentTemplate template, @NotNull String capabilityKey)
void	saveEphemeralAgentsBaseConfiguration(@NotNull EphemeralAgentsConfiguration ephemeralAgentsConfiguration)	Persist ephemeral agents configuration.
void	saveEphemeralAgentTemplate(@NotNull EphemeralAgentTemplate ephemeralAgentTemplate)	Saves specified Ephemeral Agent Template within the persistence layer.
TestConnectionResult	testConnection(EphemeralAgentsConfiguration configuration)	Validate ephemeral agents configuration and perform attempt to connect provider with provided settings.

Method Details

getEphemeralAgentsBaseConfiguration

EphemeralAgentsConfiguration getEphemeralAgentsBaseConfiguration()

Returns:

ephemeral agents configuration

saveEphemeralAgentsBaseConfiguration

void saveEphemeralAgentsBaseConfiguration(@NotNull
 @NotNull EphemeralAgentsConfiguration ephemeralAgentsConfiguration)
                                   throws WebValidationException

Persist ephemeral agents configuration.

Throws:

WebValidationException - when settings are not valid

testConnection

TestConnectionResult testConnection(EphemeralAgentsConfiguration configuration)

Validate ephemeral agents configuration and perform attempt to connect provider with provided settings.

Returns:

result of connection attempt

getEphemeralAgentTemplates

@NotNull
@NotNull List<EphemeralAgentTemplate> getEphemeralAgentTemplates()

Gets all available Ephemeral Agent Templates.

Returns:

list of the configurations

getEphemeralAgentTemplates

@NotNull
@NotNull List<EphemeralAgentTemplate> getEphemeralAgentTemplates(@Nullable
 @Nullable String filter,
 int start,
 int limit)

Gets list of Ephemeral Agent Templates filtered. It supports pagination.

Returns:

list of templates

getEphemeralAgentTemplate

@NotNull
@NotNull Optional<EphemeralAgentTemplate> getEphemeralAgentTemplate(long id)

Gets the Ephemeral Agent Template for the requested ID if the one exist.

Parameters:

id - entity identifier

Returns:

value if the one exists, empty otherwise

saveEphemeralAgentTemplate

void saveEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)
                         throws TemplateValidationException,
EphemeralAgentsService.DuplicateTemplateNameException

Saves specified Ephemeral Agent Template within the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to save

Throws:

TemplateValidationException

EphemeralAgentsService.DuplicateTemplateNameException

deleteEphemeralAgentTemplate

void deleteEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Deletes specified Ephemeral Agent Template from the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to delete

copyEphemeralAgentTemplate

@NotNull
@NotNull EphemeralAgentTemplate copyEphemeralAgentTemplate(@NotNull
 @NotNull EphemeralAgentTemplate ephemeralAgentTemplate)

Copies specified Ephemeral Agent Template and saves it within the persistence layer.

Parameters:

ephemeralAgentTemplate - entity to copy

Returns:

copy of the entity

Since:

9.4.0

isEphemeralAgentsEnabled

boolean isEphemeralAgentsEnabled()

Returns:

true if ephemeral agents functionality is enabled

addOrUpdateCapability

void addOrUpdateCapability(@NotNull
 @NotNull EphemeralAgentTemplate template,
 @NotNull
 @NotNull Capability capability)
                    throws WebValidationException

Throws:

WebValidationException

removeCapability

void removeCapability(@NotNull
 @NotNull EphemeralAgentTemplate template,
 @NotNull
 @NotNull String capabilityKey)