jetbrains.buildServer.serverSide
Interface BuildHistory

public interface BuildHistory

Provides ability to operate with TeamCity finished builds.

Method Summary

java.util.Collection<SFinishedBuild>	findEntries(java.util.Collection<java.lang.Long> buildIds) Returns collection of finished builds corresponding to the specified build ids.
SFinishedBuild	findEntry(long buildId) Finds entry with the specified id.
SFinishedBuild	findEntry(java.lang.String buildTypeId, java.lang.String buildNumber) Finds entry inside specified configuration by specified build number.
java.util.List<SFinishedBuild>	getEntries(boolean includeCanceled) Return whole build history for all build configurations of all projects.
java.util.List<SFinishedBuild>	getEntries(java.lang.String buildTypeId, User user, boolean includeCanceled) Deprecated. use SBuildType#getEntries instead, will be removed after Calcutta 4.0
java.util.List<SFinishedBuild>	getEntriesBefore(SBuild beforeThisBuild, boolean successfulOnly) Returns builds of the specified configuration started before the specified build (excluding the specified build).
java.util.List<SFinishedBuild>	getEntriesSince(java.util.Date sinceDate, BuildType buildType) Deprecated. will be removed after Calcutta
java.util.List<SFinishedBuild>	getEntriesSince(long since, User user) Deprecated. will be removed after Calcutta
java.util.List<SFinishedBuild>	getEntriesSince(SBuild sinceBuildInclusive, BuildType buildType) Returns builds of the specified configuration started after the specified build (including the specified build), ordered by changes.
void	processEntries(jetbrains.buildServer.util.ItemProcessor<SFinishedBuild> itemProcessor) Invokes the given ItemProcessor for all history records existing in the system.
void	processEntries(java.lang.String buildTypeId, User user, boolean includePersonalBuildsIfUserNotSpecified, boolean includeCanceled, boolean orderByChanges, jetbrains.buildServer.util.ItemProcessor<SFinishedBuild> processor) Process build history for the specified build configuration.
boolean	removeEntry(long buildId) Removes finished build from the history.
void	removeEntry(SFinishedBuild buildHistoryEntry) Removes finished build from the history.

Method Detail

getEntries

java.util.List<SFinishedBuild> getEntries(boolean includeCanceled)

Return whole build history for all build configurations of all projects. Personal builds are not included. Build ordering is by start time.

Parameters:

includeCanceled - true if cancelled builds should be included into result

Returns:

list of builds, most recent first

processEntries

void processEntries(java.lang.String buildTypeId,
                    @Nullable
                    User user,
                    boolean includePersonalBuildsIfUserNotSpecified,
                    boolean includeCanceled,
                    boolean orderByChanges,
                    @NotNull
                    jetbrains.buildServer.util.ItemProcessor<SFinishedBuild> processor)

Process build history for the specified build configuration. Personal builds are included if user is specified. Builds are processed using given processor.

Parameters:

buildTypeId - id of build configuration

user - if not null, personal builds of this user will be included into result

includePersonalBuildsIfUserNotSpecified - if true and user==null, all personal builds will be included into results

includeCanceled - true if cancelled builds should be included into result

orderByChanges - if true, builds are ordered by changes, i.e. most recent build with recent changes goes first; if false, most recent builds go first, regardless change order

processor - processor for builds

getEntriesSince

java.util.List<SFinishedBuild> getEntriesSince(@Nullable
                                               SBuild sinceBuildInclusive,
                                               @NotNull
                                               BuildType buildType)

Returns builds of the specified configuration started after the specified build (including the specified build), ordered by changes. History builds which contain changes older than in sinceBuildInclusive are not included.

Parameters:

sinceBuildInclusive - boundary for returning builds (inclusive), may be null - in this case all builds are returned

buildType - specified configuration.

Returns:

see above

getEntriesBefore

java.util.List<SFinishedBuild> getEntriesBefore(@NotNull
                                                SBuild beforeThisBuild,
                                                boolean successfulOnly)

Returns builds of the specified configuration started before the specified build (excluding the specified build). Personal builds are included, canceled builds are excluded. Returned builds are sorted by containing changes and than by build start time (if contain same changes). Recent builds go first.

Parameters:

beforeThisBuild - returns build before this one

successfulOnly - if only successful builds should be included.

Returns:

see above

findEntries

java.util.Collection<SFinishedBuild> findEntries(java.util.Collection<java.lang.Long> buildIds)

Returns collection of finished builds corresponding to the specified build ids. The collection will contain existing builds only. NOTE: RETURNED COLLECTION WILL NOT MAINTAIN REQUESTED ORDER!

Parameters:

buildIds - id list to find builds with these ids.

Returns:

collection of finished builds corresponding to the specified build ids.

findEntry

@Nullable
SFinishedBuild findEntry(long buildId)

Finds entry with the specified id.

Parameters:

buildId - specified build id.

Returns:

entry with the specified id, null if it does not exist or invisible for the current user.

findEntry

@Nullable
SFinishedBuild findEntry(@NotNull
                                  java.lang.String buildTypeId,
                                  @NotNull
                                  java.lang.String buildNumber)

Finds entry inside specified configuration by specified build number.

Parameters:

buildTypeId - specified build configuration id.

buildNumber - specified build number.

Returns:

entry with the specified number in the specified configuration, null if it does not exist or invisible for the current user.

removeEntry

void removeEntry(SFinishedBuild buildHistoryEntry)

Removes finished build from the history.

Parameters:

buildHistoryEntry - specified finished build.

removeEntry

boolean removeEntry(long buildId)

Removes finished build from the history.

Parameters:

buildId - build identifier.

Returns:

true if the build was successfully removed

processEntries

void processEntries(@NotNull
                    jetbrains.buildServer.util.ItemProcessor<SFinishedBuild> itemProcessor)

Invokes the given ItemProcessor for all history records existing in the system. Entries are pushed into the processor in the most-recent-first order.

Parameters:

itemProcessor - processor for history entries

getEntriesSince

java.util.List<SFinishedBuild> getEntriesSince(long since,
                                               User user)

Deprecated. will be removed after Calcutta

Returns entries started after the specified build, with personal builds for the specified user.

Parameters:

since - build id to find history entries after.

user - user to include personal builds for. If user is null no personal builds will be included.

Returns:

entries started after the specified build.

getEntriesSince

java.util.List<SFinishedBuild> getEntriesSince(java.util.Date sinceDate,
                                               BuildType buildType)

Deprecated. will be removed after Calcutta

Returns entries with start date after the specified date corresponding to specified build type

Parameters:

sinceDate - specified start date.

buildType - specified configuration.

Returns:

entries with start date after the specified date corresponding to specified build type.

getEntries

java.util.List<SFinishedBuild> getEntries(java.lang.String buildTypeId,
                                          @Nullable
                                          User user,
                                          boolean includeCanceled)

Deprecated. use SBuildType#getEntries instead, will be removed after Calcutta 4.0

Return build history for the specified build configuration. Personal builds are included if user is specified. Build order is by start time.

Parameters:

includeCanceled - true if cancelled builds should be included into result

user - if not null, personal builds of this user will be included into result

buildTypeId - id of build configuration

Returns:

list of builds, most recent first