Package jetbrains.buildServer.serverSide.statistics.diskusage

Interface DiskUsageViewer

All Known Implementing Classes:

DiskUsage

public interface DiskUsageViewer

Created by Andrey Titov on 01.02.16.

Method Summary

Modifier and Type	Method	Description
long	getArtifactsDirectoryFreeSpace()	The return value is usable disk space
long	getLastUpdateDate(SBuildType buildType)
long	getLastUpdateDuration()
Date	getLastUpdateTime()
long	getLogsDirectoryFreeSpace()	The return value is usable disk space
long	getPinnedArtifactsSize()
long	getPinnedBuildsArtifactsSize(SBuildType buildType)
long	getPinnedBuildsLogsSize(SBuildType buildType)
long	getPinnedBuildsNumber()
long	getPinnedBuildsNumber(SBuildType buildType)
long	getPinnedBuildsSize(SBuildType buildType)
long	getPinnedLogsSize()
long	getTotalArtifactsSize()
long	getTotalLogsSize()
long	getVersion(SBuildType buildType)	Disk usage data is stored versioned.
CompositeDiskUsageData	peekData(SBuildType bt)	Disk usage data is stored in cache so it could be outdated.
List<CompositeDiskUsageData>	peekData(SProject project)	Disk usage data is stored in cache so it could be outdated.
DiskUsageProjectRow	peekHierarchy(SProject rootProject)	Peeks collected data for all projects.
DiskUsageProjectRow	peekHierarchySingleProject(SProject rootProject)
DiskUsageRow	peekRow(SBuildType bt)	This method peeks collected data for a build type wrapping data objects to DiskUsageRow instances.
Map<SProject,DiskUsageProjectRow>	peekRows(Collection<SProject> project)	This method peeks collected data for a number of projects wrapping data objects to DiskUsageProjectRow instances.
List<DiskUsageRow>	peekRows(SProject project)	This method peeks collected data for a project wrapping data objects to DiskUsageRow instances.

Method Detail

peekRows

@NotNull
Map<SProject,DiskUsageProjectRow> peekRows(@NotNull
                                                 Collection<SProject> project)

This method peeks collected data for a number of projects wrapping data objects to DiskUsageProjectRow instances. As peek method it doesn't recalculate missing data.

Parameters:

project - projects to collect rows

Returns:

map of packed rows.

peekHierarchy

@NotNull
DiskUsageProjectRow peekHierarchy(@NotNull
                                  SProject rootProject)

Peeks collected data for all projects. Doesn't recalculate missing data

Parameters:

rootProject -

Returns:

peekHierarchySingleProject

@NotNull
DiskUsageProjectRow peekHierarchySingleProject(@NotNull
                                               SProject rootProject)

peekData

@NotNull
CompositeDiskUsageData peekData(@NotNull
                                SBuildType bt)

Disk usage data is stored in cache so it could be outdated. Use recalculateData or DiskUsageTaskExecutor to update values.

This method doesn't calculate data when it's not available

Parameters:

bt - Build type to collect disk usage data for

Returns:

disk usage data over one BuildType

peekData

@NotNull
List<CompositeDiskUsageData> peekData(@NotNull
                                      SProject project)

Disk usage data is stored in cache so it could be outdated. Use recalculateData or DiskUsageTaskExecutor to update values.

This method doesn't calculate data when it's not available

Parameters:

project - Project to collect usage data in

Returns:

disk usage data over all configurations in specified project

peekRows

@NotNull
List<DiskUsageRow> peekRows(@NotNull
                            SProject project)

This method peeks collected data for a project wrapping data objects to DiskUsageRow instances. As peek method it doesn't recalculate missing data.

Parameters:

project - project to collect rows

Returns:

list of packed rows.

peekRow

@Nullable
DiskUsageRow peekRow(@NotNull
                     SBuildType bt)

This method peeks collected data for a build type wrapping data objects to DiskUsageRow instances. As peek method it doesn't recalculate missing data.

Parameters:

bt - build configuration to collect rows

Returns:

packed row

getVersion

long getVersion(@Nullable
                SBuildType buildType)

Disk usage data is stored versioned. 0 means data was not collected yet.

Parameters:

buildType -

Returns:

version

getLastUpdateDate

long getLastUpdateDate(@Nullable
                       SBuildType buildType)

getArtifactsDirectoryFreeSpace

long getArtifactsDirectoryFreeSpace()

The return value is usable disk space

Returns:

free disk space in artifacts directory or ArtifactStorageDiskUsageCalculator.UNLIMITED_SPACE if the space is not limited

getLogsDirectoryFreeSpace

long getLogsDirectoryFreeSpace()

The return value is usable disk space

Returns:

free disk space in logs directory or ArtifactStorageDiskUsageCalculator.UNLIMITED_SPACE if the space is not limited

getPinnedBuildsNumber

long getPinnedBuildsNumber()

Returns:

number of found pinned builds

getPinnedArtifactsSize

long getPinnedArtifactsSize()

Returns:

size of all artifacts in found pinned builds

getPinnedLogsSize

long getPinnedLogsSize()

Returns:

size of all logs in found pinned builds

getPinnedBuildsNumber

long getPinnedBuildsNumber(@NotNull
                           SBuildType buildType)

Parameters:

buildType -

Returns:

number of found pinned builds in specified BuildType

getPinnedBuildsSize

long getPinnedBuildsSize(@NotNull
                         SBuildType buildType)

Parameters:

buildType -

Returns:

total size of artifacts and logs in found pinned builds of specified BuildType

getPinnedBuildsArtifactsSize

long getPinnedBuildsArtifactsSize(@NotNull
                                  SBuildType buildType)

Parameters:

buildType -

Returns:

total size of artifacts in found pinned builds of specified BuildType

getPinnedBuildsLogsSize

long getPinnedBuildsLogsSize(@NotNull
                             SBuildType buildType)

Parameters:

buildType -

Returns:

total size of logs in found pinned builds of specified BuildType

getTotalArtifactsSize

long getTotalArtifactsSize()

Returns:

size of all found artifacts

getTotalLogsSize

long getTotalLogsSize()

Returns:

size of all found logs

getLastUpdateTime

@Nullable
Date getLastUpdateTime()

Returns:

last full scan date

getLastUpdateDuration

long getLastUpdateDuration()

Returns:

last full scan duration