com.atlassian.bamboo.plan

Interface ExecutableAgentsHelper

@Internal
public interface ExecutableAgentsHelper

Utility class to determine which agents can build a Plan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExecutableAgentsHelper.ExecutableQuery
static class	ExecutableAgentsHelper.ExecutorQuery

Method Summary

Methods

Modifier and Type	Method and Description
Collection<BuildAgent>	getExecutableAgents(ExecutableAgentsHelper.ExecutorQuery executorQuery)
ExecutableAgentsMatrix	getExecutableAgentsMatrix(ExecutableAgentsHelper.ExecutorQuery executorQuery)
Collection<ImmutableBuildable>	getExecutableBuildables(ExecutableAgentsHelper.ExecutableQuery executableQuery) Collection of buildables for which this agent can execute.
Collection<ElasticImageConfiguration>	getExecutableImages(ExecutableAgentsHelper.ExecutorQuery executorQuery) Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.
boolean	planHasExecutableAgents(PlanKey planKey, boolean includeDisabled) Checks if a Buildable can be built on any defined agent.
boolean	planHasExecutableAgents(PlanResultKey planResultKey) Checks if a Buildable can be built on any active agent.

Method Detail

planHasExecutableAgents

boolean planHasExecutableAgents(@NotNull
                              PlanKey planKey,
                              boolean includeDisabled)

Checks if a Buildable can be built on any defined agent.

Parameters:

planKey -

includeDisabled - indicate whether disabled agents should be included in checking

Returns:

Throws:

IllegalArgumentException - if planKey is not a Buildable key

planHasExecutableAgents

boolean planHasExecutableAgents(@NotNull
                              PlanResultKey planResultKey)

Checks if a Buildable can be built on any active agent.

Parameters:

planResultKey -

Returns:

Throws:

IllegalArgumentException - if planResultKey is not a key of running Job

getExecutableImages

Collection<ElasticImageConfiguration> getExecutableImages(@NotNull
                                                        ExecutableAgentsHelper.ExecutorQuery executorQuery)

Calculates the list of elastic images that are capable of running an agent that can build a Buildable plan.

Returns:

getExecutableAgents

Collection<BuildAgent> getExecutableAgents(@NotNull
                                         ExecutableAgentsHelper.ExecutorQuery executorQuery)

getExecutableAgentsMatrix

ExecutableAgentsMatrix getExecutableAgentsMatrix(@NotNull
                                               ExecutableAgentsHelper.ExecutorQuery executorQuery)

getExecutableBuildables

Collection<ImmutableBuildable> getExecutableBuildables(ExecutableAgentsHelper.ExecutableQuery executableQuery)

Collection of buildables for which this agent can execute. Checks capabilities and agent assignments