Package jetbrains.buildServer.vcs

Interface VcsRootInstance

All Superinterfaces:

Loggable, LVcsRoot, LVcsRootInstance, VcsRoot

All Known Subinterfaces:

VcsRootInstanceEx

All Known Implementing Classes:

VcsRootInstanceImpl, VcsRootInstanceWithParent

public interface VcsRootInstance
extends LVcsRootInstance

Represents instance of VCS root settings (i.e. settings with all parameters resolved).

Since:

6.5

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
SVcsModification	findModificationById(long modId)	Returns VCS modification object associated with this VCS root instance and having the specified id.
SVcsModification	findModificationByVersion(String version)	Searches for a VCS modification object associated with this VCS root and having the specified version (aka revision)
Long	findModificationIdByVersion(String version)	Same as findModificationByVersion(String) but retuns id of the VCS modification.
RepositoryVersion	getCurrentRevision()
DAG<Long>	getDag()	Returns DAG of VCS commits, for non DAG based VCS root instances the method will return a linear DAG.
int	getEffectiveModificationCheckInterval()
RepositoryVersion	getLastUsedRevision()
SVcsRoot	getParent()
Map<SBuildType,CheckoutRules>	getUsages()
boolean	isDagBased()
boolean	isPollingMode()	The polling mode is enabled by default.

Methods inherited from interface jetbrains.buildServer.log.Loggable

describe

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRoot

getDescription, getVcsDisplayName

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRootInstance

findService, getCheckoutPropertiesHash, getParentId, getService, getService, getStatus, getVersionDisplayName, isCurrentVersionExpensive

Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot

getExternalId, getId, getName, getProperties, getProperty, getProperty, getVcsName

Method Detail

isDagBased

boolean isDagBased()

Returns:

true if root is from dag-based VCS and feature branches support is enabled for it, false otherwise or if VCS for the root cannot be found

Since:

9.1

getCurrentRevision

@NotNull
RepositoryVersion getCurrentRevision()
                              throws VcsException

Returns:

current revision in VCS for this VCS root (same as CollectSingleStatePolicy.getCurrentVersion(VcsRoot)).

Throws:

VcsException

Since:

6.5

getLastUsedRevision

@Nullable
RepositoryVersion getLastUsedRevision()

Returns:

previous revision used to collect changes by this VCS root

Since:

6.5

getParent

@NotNull
SVcsRoot getParent()

Returns:

parent VCS root object which unresolved parameters were used to construct this instance.

getUsages

@NotNull
Map<SBuildType,CheckoutRules> getUsages()

Returns:

all usages of this VCS root _instance_ in various build configurations. Usages in versioned settings are not returned.

Since:

6.5

getEffectiveModificationCheckInterval

int getEffectiveModificationCheckInterval()

Returns:

Effective modification check interval in seconds for this VcsRootInstance, either default, or an explicitly set

Since:

10.0

isPollingMode

boolean isPollingMode()

The polling mode is enabled by default. If recently detected changes came via a commit hook from the VCS server, this mode is disabled.

Returns:

see above

Since:

2019.1

See Also:

OperationRequestor

findModificationByVersion

@Nullable
SVcsModification findModificationByVersion(@NotNull
                                           String version)

Searches for a VCS modification object associated with this VCS root and having the specified version (aka revision)

Parameters:

version - a version of a VCS modification object

Returns:

a found object or null

Since:

2024.12

findModificationIdByVersion

@Nullable
Long findModificationIdByVersion(@NotNull
                                 String version)

Same as findModificationByVersion(String) but retuns id of the VCS modification.

Parameters:

version - a version of a VCS modification object

Returns:

an id of a found object or null

Since:

2024.12

findModificationById

@Nullable
SVcsModification findModificationById(long modId)

Returns VCS modification object associated with this VCS root instance and having the specified id.

Parameters:

modId - id of a VCS modification

Returns:

found VCS modification or null

Since:

2024.12

getDag

@NotNull
DAG<Long> getDag()

Returns DAG of VCS commits, for non DAG based VCS root instances the method will return a linear DAG.

Returns:

see above

Since:

2024.12