com.atlassian.bamboo.v2.build.requirement

Interface RequirementService

@ExperimentalApi
public interface RequirementService

Service to provide actions on Job Requirements

Since:

v5.6

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableRequirement	addRequirement(PlanKey jobKey, String key, ImmutableRequirement.MatchType matchType, String matchValue) Add new requirement to a job.
ExecutableAgentsMatrix	getExecutableAgentMatrixForJob(PlanKey jobKey) retrieve all executable agents for a particular job.
ImmutableRequirement	getRequirementForJob(PlanKey jobKey, long requirementId) Get a single requirement for a job.
List<? extends ImmutableRequirement>	getRequirementsForJob(PlanKey jobKey) Get all requirements for jobs.
void	removeRequirement(PlanKey jobKey, long requirementId) Remove a specific requirement
ImmutableRequirement	updateRequirement(PlanKey jobKey, long requirementId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Update an existing requirement.
ErrorCollection	validateRequirementForAdd(PlanKey jobKey, String key, ImmutableRequirement.MatchType matchType, String matchValue) Validate requirement details.
ErrorCollection	validateRequirementForUpdate(PlanKey jobKey, long requirementId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Validate requirement details

Method Detail

getRequirementsForJob

@NotNull
List<? extends ImmutableRequirement> getRequirementsForJob(@NotNull
                                                                 PlanKey jobKey)
                                                           throws WebValidationException

Get all requirements for jobs. If a branch job, will get master requirements.

Parameters:

jobKey - of job

Returns:

RequirementSet for job

Throws:

WebValidationException - if job key invalid

getRequirementForJob

@NotNull
ImmutableRequirement getRequirementForJob(@NotNull
                                                PlanKey jobKey,
                                                long requirementId)

Get a single requirement for a job. If a branch job, will retrieve requirement from master

Parameters:

jobKey - of job

requirementId - of requirement

Returns:

requirement

Throws:

NotFoundException - if job key is invalid or requirement doesn't exist

validateRequirementForAdd

@NotNull
ErrorCollection validateRequirementForAdd(@NotNull
                                                PlanKey jobKey,
                                                @Nullable
                                                String key,
                                                @Nullable
                                                ImmutableRequirement.MatchType matchType,
                                                @Nullable
                                                String matchValue)

Validate requirement details. Assumes details will be used to add a new requirement

Parameters:

jobKey - of job requirement will be added to

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

error collection containing any validation errors

addRequirement

@NotNull
ImmutableRequirement addRequirement(@NotNull
                                          PlanKey jobKey,
                                          @NotNull
                                          String key,
                                          @NotNull
                                          ImmutableRequirement.MatchType matchType,
                                          @Nullable
                                          String matchValue)
                                    throws WebValidationException

Add new requirement to a job. Can only add requirements to the master job.

Parameters:

jobKey - of job to add to, must not be a branch

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

Created requirement

Throws:

WebValidationException - for any data related error.

validateRequirementForUpdate

@NotNull
ErrorCollection validateRequirementForUpdate(@NotNull
                                                   PlanKey jobKey,
                                                   long requirementId,
                                                   @Nullable
                                                   String key,
                                                   @Nullable
                                                   ImmutableRequirement.MatchType matchType,
                                                   @Nullable
                                                   String matchValue)

Validate requirement details

Parameters:

jobKey - of job requirement belongs to

requirementId - if of the requirement being updated

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

error collection containing any validation errors

updateRequirement

@NotNull
ImmutableRequirement updateRequirement(@NotNull
                                             PlanKey jobKey,
                                             long requirementId,
                                             @NotNull
                                             String key,
                                             @NotNull
                                             ImmutableRequirement.MatchType matchType,
                                             @Nullable
                                             String matchValue)
                                       throws WebValidationException

Update an existing requirement. Can only update requirements of master jobs

Parameters:

jobKey - of job requirement belongs to

requirementId - if of the requirement being updated

key - of requirement to match with the capability

matchType - e.g. exists, regex match, equals

matchValue - for regex and equals the value the requirement should match

Returns:

Created requirement

Throws:

WebValidationException - for any data related error.

removeRequirement

void removeRequirement(@NotNull
                     PlanKey jobKey,
                     long requirementId)
                       throws WebValidationException

Remove a specific requirement

Parameters:

jobKey - requirement belongs to

requirementId - of requirement to remove

Throws:

WebValidationException - if requirement is not allowed to be removed

getExecutableAgentMatrixForJob

@NotNull
ExecutableAgentsMatrix getExecutableAgentMatrixForJob(@NotNull
                                                            PlanKey jobKey)
                                                      throws WebValidationException

retrieve all executable agents for a particular job. Includes all disabled and offline.

Parameters:

jobKey -

Returns:

executableAgentMatrix (requirements to matching agents and images)

Throws:

WebValidationException