jetbrains.buildServer.serverSide.statistics.build

Interface BuildDataStorage

public interface BuildDataStorage

Storage for build statistic values.

Method Summary

Modifier and Type	Method and Description
java.util.SortedSet<java.lang.String>	getAgents(BuildChartSettings chartSettings) Returns agents list for given filter settings.
java.util.List<java.lang.String>	getAvailableMetricsForBuildType(java.lang.String buildTypeExternalId) Returns collection of available value type keys for specified build configuration
BuildValue	getData(java.lang.String valueTypeKey, BuildValueTransformer buildValueTransformer, long finishedBuildId, java.lang.String externalBuildTypeId) Deprecated. since 8.0 use getData(String, BuildValueTransformer, jetbrains.buildServer.serverSide.SBuild) or SBuild.getStatisticValue(String).
BuildValue	getData(java.lang.String valueTypeKey, BuildValueTransformer buildValueTransformer, SBuild build) Get individual statistic value for given value type and build (finished or running)
java.util.List<BuildValue>	getDataSet(java.lang.String valueTypeKey, BuildChartSettings chartSettings, BuildValueTransformer buildValueTransformer) Retrieve sorted list of values for given metric, filtered according to given settings.
java.math.BigDecimal	getValue(java.lang.String valueTypeKey, long buildId) Same as getValue(String, SBuild).
java.math.BigDecimal	getValue(java.lang.String valueTypeKey, SBuild build) Returns raw statistic value as it is stored in database for a given value type and a build.
java.util.Map<java.lang.String,java.math.BigDecimal>	getValues(SBuild build) All raw values for a given build.
java.util.Set<java.lang.String>	getValueTypeKeys(java.lang.String prefix) Get all available ValueType keys filtering by prefix
java.util.Set<java.lang.String>	getValueTypeKeys(java.lang.String prefix, java.lang.String buildTypeExternalId) Get all available ValueType keys for a build configuration filtering by prefix
boolean	hasDataFor(java.lang.String valueTypeKey, SBuild build) Flags whether any data was stored for given metric & build pair
boolean	hasDataFor(java.lang.String valueTypeKey, java.lang.String externalBuildTypeId) Flags whether any data was stored for given metric & buildTypeId pair
void	publishValue(java.lang.String valueTypeKey, long buildId, java.math.BigDecimal value) Store single build statistic value for a build with specified id
void	publishValues(long buildId, java.util.Map<java.lang.String,java.math.BigDecimal> statValues) Publishes several values at once.

Method Detail

getAvailableMetricsForBuildType

@NotNull
java.util.List<java.lang.String> getAvailableMetricsForBuildType(@NotNull
                                                                           java.lang.String buildTypeExternalId)

Returns collection of available value type keys for specified build configuration

Parameters:

buildTypeExternalId - external id of build configuration

Returns:

see above

getDataSet

@NotNull
java.util.List<BuildValue> getDataSet(@NotNull
                                                java.lang.String valueTypeKey,
                                                @NotNull
                                                BuildChartSettings chartSettings,
                                                @Nullable
                                                BuildValueTransformer buildValueTransformer)

Retrieve sorted list of values for given metric, filtered according to given settings. There will be BuildValue object for each build, even if there is no metric value for the given build.

Parameters:

valueTypeKey - metric key

chartSettings - build chart settings

buildValueTransformer - optional transformer to be applied to each value

Returns:

list of metric values combined with its build data

getData

@Deprecated
 @Nullable
BuildValue getData(@NotNull
                                            java.lang.String valueTypeKey,
                                            @Nullable
                                            BuildValueTransformer buildValueTransformer,
                                            long finishedBuildId,
                                            @Nullable
                                            java.lang.String externalBuildTypeId)

Deprecated. since 8.0 use getData(String, BuildValueTransformer, jetbrains.buildServer.serverSide.SBuild) or SBuild.getStatisticValue(String).

Get individual statistic value for given value type and finished build

Parameters:

valueTypeKey - metric key

buildValueTransformer - optional transformer to be applied to the value

finishedBuildId - identifier of the finished build

externalBuildTypeId - external identifier of the build configuration

Returns:

metric value for given parameters, null if not available

getData

@Nullable
BuildValue getData(@NotNull
                              java.lang.String valueTypeKey,
                              @Nullable
                              BuildValueTransformer buildValueTransformer,
                              @NotNull
                              SBuild build)

Get individual statistic value for given value type and build (finished or running)

Parameters:

valueTypeKey - metric key

buildValueTransformer - optional transformer to be applied to the value

build - finished or running build

Returns:

metric value for given parameters, null if not available

Since:

8.0

getAgents

@NotNull
java.util.SortedSet<java.lang.String> getAgents(@NotNull
                                                          BuildChartSettings chartSettings)

Returns agents list for given filter settings.

Parameters:

chartSettings - build chart settings

Returns:

agent names

hasDataFor

@Contract(value="_, null -> false")
boolean hasDataFor(@NotNull
                                                        java.lang.String valueTypeKey,
                                                        @Nullable
                                                        java.lang.String externalBuildTypeId)

Flags whether any data was stored for given metric & buildTypeId pair

Parameters:

valueTypeKey - metric key

externalBuildTypeId - build configuration external identifier

Returns:

true if there is some data for given metric and given buildTypeId

hasDataFor

boolean hasDataFor(@NotNull
                   java.lang.String valueTypeKey,
                   @NotNull
                   SBuild build)

Flags whether any data was stored for given metric & build pair

Parameters:

valueTypeKey - metric key

build - build to check

Returns:

true if there is some data for given metric and given buildTypeId

getValue

@Nullable
java.math.BigDecimal getValue(@NotNull
                                         java.lang.String valueTypeKey,
                                         @NotNull
                                         SBuild build)

Returns raw statistic value as it is stored in database for a given value type and a build. Note that raw value can differ from one returned by getData(String, BuildValueTransformer, jetbrains.buildServer.serverSide.SBuild) method because of possible transformation applied by BuildValueTransformer.

Parameters:

valueTypeKey - metric key

build - the build

Returns:

metric value for given parameters, null if not available

Since:

10.0

getValue

@Nullable
java.math.BigDecimal getValue(@NotNull
                                         java.lang.String valueTypeKey,
                                         long buildId)

Same as getValue(String, SBuild). Since 10.0 returns statistics only for not yet cleaned builds.

getValueTypeKeys

@NotNull
java.util.Set<java.lang.String> getValueTypeKeys(@NotNull
                                                           java.lang.String prefix)

Get all available ValueType keys filtering by prefix

Will return all value types when the prefix is empty. getValueTypeKeys(String, String) should be used if build type is known.

Parameters:

prefix - Prefix to search keys. Could be empty.

Returns:

Set of all available keys starting with provided prefix.

getValueTypeKeys

@NotNull
java.util.Set<java.lang.String> getValueTypeKeys(@NotNull
                                                           java.lang.String prefix,
                                                           @NotNull
                                                           java.lang.String buildTypeExternalId)

Get all available ValueType keys for a build configuration filtering by prefix

Parameters:

prefix - Prefix to search keys. Could be empty.

buildTypeExternalId - external ID of a build type

Returns:

Set of all available keys starting with provided prefix.

getValues

@NotNull
java.util.Map<java.lang.String,java.math.BigDecimal> getValues(@NotNull
                                                                         SBuild build)

All raw values for a given build. Key of the map is value type key and value is statistic value.

Since:

8.0

publishValue

void publishValue(@NotNull
                  java.lang.String valueTypeKey,
                  long buildId,
                  @NotNull
                  java.math.BigDecimal value)

Store single build statistic value for a build with specified id

Parameters:

valueTypeKey - statistic value key

buildId - id of the build

value - value

publishValues

void publishValues(long buildId,
                   @NotNull
                   java.util.Map<java.lang.String,java.math.BigDecimal> statValues)

Publishes several values at once.

Parameters:

buildId - id of the build

statValues - map of statistic values to publish

Since:

2020.1