Package jetbrains.buildServer.vcs
Interface ChangeStatus
-
public interface ChangeStatus
Holds the details data related to a single change. The information returned by this interface is not 'live', i.e. it is cached and calculated for the moment when instance of the interface is returned.- Since:
- 5.1
- Author:
- Maxim Podkolzine (maxim.podkolzine@jetbrains.com)
- See Also:
ChangeStatusProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<SBuildType,BuildTypeChangeStatus>
getBuildTypesStatus()
Get status of the change in various configurations.java.util.Map<SBuildType,BuildPromotion>
getBuildTypesStatusMap()
SVcsModification
getChange()
If this ChangeStatus relates to a single modification, returns this modification (no merge case).java.util.Map<SBuildType,BuildPromotion>
getDeploymentStatus()
int
getFailedCount()
Returns the number of failing builds (including those running and failing).int
getFinishedBuildsNumber()
Returns the number of finished builds (among first builds containing this change).java.util.Map<SBuildType,SBuild>
getFirstBuilds()
For non-personal builds, returns map of build configuration -> build where modifications from this change were included for the first time.MergedVcsModificationInfo
getMergedVcsModificationInfo()
Returns merged information about change for all duplicates.int
getPendingBuildsTypesNumber()
Returns the number of pending builds types.java.util.List<SBuildType>
getRelatedConfigurations()
Returns collection of build configurations affected by this change, including personal BuildTypes Configurations are sorted by project name, configuration name (case insensitive)int
getRunningBuildsNumber()
Returns the number of running builds (among first builds containing this change).int
getSuccessCount()
Returns the number of successful builds.boolean
isCanceledPersonal()
For personal changes, returns true if one of the personal builds, included into the change, was canceledboolean
isSuccessful()
Returns whether change status is successful for the current moment (i.e.
-
-
-
Method Detail
-
getChange
@NotNull SVcsModification getChange()
If this ChangeStatus relates to a single modification, returns this modification (no merge case).
If this Change Status is a merged status, this method returns the very first detected modification related to this ChangeStatus. I.e. in this case, returned modification will have a minimum ID among all duplicated modifications, related to the change.
-
getMergedVcsModificationInfo
@NotNull MergedVcsModificationInfo getMergedVcsModificationInfo()
Returns merged information about change for all duplicates.- Returns:
- see above
-
getFinishedBuildsNumber
int getFinishedBuildsNumber()
Returns the number of finished builds (among first builds containing this change).- Returns:
- number of finished builds
-
getRunningBuildsNumber
int getRunningBuildsNumber()
Returns the number of running builds (among first builds containing this change).- Returns:
- number of running builds
-
getPendingBuildsTypesNumber
int getPendingBuildsTypesNumber()
Returns the number of pending builds types.- Returns:
- number of pending builds types
-
getFailedCount
int getFailedCount()
Returns the number of failing builds (including those running and failing).- Returns:
- number of currently failed build configurations
-
getSuccessCount
int getSuccessCount()
Returns the number of successful builds.- Returns:
- number of build configurations, which have successful builds with this change.
- See Also:
BuildTypeChangeStatus.isSuccessful()
-
isSuccessful
boolean isSuccessful()
Returns whether change status is successful for the current moment (i.e. is successful for all build types and there are no pending builds).- Returns:
- see above
-
isCanceledPersonal
boolean isCanceledPersonal()
For personal changes, returns true if one of the personal builds, included into the change, was canceled- Returns:
- see above
- Since:
- 6.0
-
getFirstBuilds
@NotNull java.util.Map<SBuildType,SBuild> getFirstBuilds()
For non-personal builds, returns map of build configuration -> build where modifications from this change were included for the first time. Cancelled and personal builds are ignored. For personal builds, returns a map from a buildType to the corresponding build which contains this personal change This method is similar toSVcsModification.getFirstBuilds()
, but it works across merged modifications included to this change.- Since:
- 6.0
- See Also:
SVcsModification.getFirstBuilds()
,getBuildTypesStatus()
-
getRelatedConfigurations
@NotNull java.util.List<SBuildType> getRelatedConfigurations()
Returns collection of build configurations affected by this change, including personal BuildTypes Configurations are sorted by project name, configuration name (case insensitive)- Returns:
- see above
- Since:
- 6.5
-
getBuildTypesStatus
@NotNull java.util.Map<SBuildType,BuildTypeChangeStatus> getBuildTypesStatus()
Get status of the change in various configurations. Method returns a map from change-related configurations to related configuration status object. Map keys are ordered by project name, configuration name (case insensitive)- Returns:
- see above
- Since:
- 7.0
- See Also:
BuildTypeChangeStatus
-
getBuildTypesStatusMap
@NotNull java.util.Map<SBuildType,BuildPromotion> getBuildTypesStatusMap()
- Returns:
- map of build type to build promotion affected by the change
- Since:
- 2017.2
-
getDeploymentStatus
@NotNull java.util.Map<SBuildType,BuildPromotion> getDeploymentStatus()
- Returns:
- deployment status of the change: map of environment build type to
BuildPromotion
instance - Since:
- 2017.2
-
-