com.atlassian.bitbucket.build

Interface BuildStatusService

public interface BuildStatusService

Manages build statuses.

Method Summary

Modifier and Type	Method and Description
Page<BuildStatus>	findAll(String commitId) Deprecated. in 6.7 for removal in 8.0. Please use findAll(String, PageRequest, BuildOrder)
Page<BuildStatus>	findAll(String commitId, PageRequest pageRequest, BuildOrder orderBy) Retrieves a page of build statuses associated with the specified commit.
Map<String,BuildSummary>	getSummaries(Collection<String> commitIds) Retrieves summaries for the builds associated with all of the specified commits.
BuildSummary	getSummary(String commitId) Retrieves a summary of all the builds associated with the specified commit.
void	set(BuildStatusSetRequest request) Sets the build status for a commit, replacing any existing status with the same key

Method Detail

findAll

@Deprecated
 @Nonnull
Page<BuildStatus> findAll(@Nonnull
                                                String commitId)

Deprecated. in 6.7 for removal in 8.0. Please use findAll(String, PageRequest, BuildOrder)

Retrieves a page of build statuses associated with the specified commit. By default the page size is 100 and the order is BuildOrder.NEWEST

Parameters:

commitId - the ID of the commit to retrieve builds for

Returns:

a page of build statuses

Throws:

AuthorisationException - if the current user is not licensed

findAll

@Nonnull
Page<BuildStatus> findAll(@Nonnull
                                   String commitId,
                                   @Nonnull
                                   PageRequest pageRequest,
                                   @Nonnull
                                   BuildOrder orderBy)

Retrieves a page of build statuses associated with the specified commit.

Parameters:

commitId - the ID of the commit to retrieve builds for

pageRequest - the page to be returned

orderBy - the field to order by in addition to descending date ordering

Returns:

a page of build statuses

Throws:

AuthorisationException - if the current user is not licensed

Since:

6.7

getSummary

@Nonnull
BuildSummary getSummary(@Nonnull
                                 String commitId)

Retrieves a summary of all the builds associated with the specified commit.

Parameters:

commitId - the ID of the commit to retrieve a summary for

Returns:

stats for all the builds associated with the commitId.

Throws:

AuthorisationException - if the current user is not licensed

getSummaries

@Nonnull
Map<String,BuildSummary> getSummaries(@Nonnull
                                               Collection<String> commitIds)

Retrieves summaries for the builds associated with all of the specified commits. If any of the specified commits do not have builds associated with them, their ID will not be included in the returned Map.

Returns:

a map from commit IDs to summaries, which can have a length smaller than the number of specified commits if any do not have build statuses associated with them.

Throws:

AuthorisationException - if the current user is not licensed

See Also:

getSummary(String)

set

void set(@Nonnull
         BuildStatusSetRequest request)

Sets the build status for a commit, replacing any existing status with the same key

Parameters:

request - describes the build status and the commit it should be associated with

Throws:

AuthorisationException - if the current user is not licensed