Package com.atlassian.bamboo.task
Interface BuildTaskRequirementSupport
- All Known Subinterfaces:
RepositoryAwareTaskConfigurator
- All Known Implementing Classes:
AbstractRepositoryAwareTaskConfigurator,AbstractVcsTaskConfigurator,GrailsTaskConfigurator,PhpUnitBuildTaskConfigurator,VcsBranchTaskConfigurator,VcsCheckoutTaskConfigurator,VcsCommitTaskConfigurator,VcsPushTaskConfigurator,VcsTagTaskConfigurator,WarningsTaskConfigurator
@PublicApi
public interface BuildTaskRequirementSupport
Allows creators of
TaskTypes to specify Requirements.
There are three interfaces which you can use for this purpose
TaskRequirementSupport: Preferred option. Will work for both deployment environments and for jobs (you can not implement the other interfaces if using this)
BuildTaskRequirementSupport: Supports Jobs only. Only use if you require the job information to generate your task's requirements (can be used in conjunction with DeploymentTaskRequirementSupport)
com.atlassian.bamboo.deployments.environments.DeploymentTaskRequirementSupport: Supports Environments only. Only use if you require the environment information to generate your task's requirements (can be used in conjunction with BuildTaskRequirementSupport)- Since:
- 3.3
-
Method Summary
Modifier and TypeMethodDescription@NotNull Set<Requirement>calculateRequirements(@NotNull TaskDefinition taskDefinition, @NotNull Job job) Populates theRequirementSetneeded based off of theTaskDefinition
-
Method Details
-
calculateRequirements
@NotNull @NotNull Set<Requirement> calculateRequirements(@NotNull @NotNull TaskDefinition taskDefinition, @NotNull @NotNull Job job) Populates theRequirementSetneeded based off of theTaskDefinition- Parameters:
taskDefinition-job-- Returns:
- requirements
-