Package jetbrains.buildServer.vcs

Interface VcsRoot

  • All Superinterfaces:
    jetbrains.buildServer.log.Loggable
    All Known Subinterfaces:
    LVcsRoot, LVcsRootInstance, SVcsRoot, VcsRootInstance
    All Known Implementing Classes:
    VcsRootImpl
    public interface VcsRoot
extends jetbrains.buildServer.log.Loggable
    Contains configuration settings of a configured version control root. VCS root settings are stored as a set of name value pairs (called properties). Names starting with "teamcity:" prefix are reserved for TeamCity internal usages. Names starting with SECURE_PROPERTY_PREFIX indicate that value of this property contains secure information, such properties are persisted in scrambled form.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getExternalId()  
      long getId()
      returns root internal id
      java.lang.String getName()
      returns descriptive name of the vcs root
      java.util.Map<java.lang.String,​java.lang.String> getProperties()
      Returns mapping from a property name to its value
      java.lang.String getProperty​(java.lang.String propertyName)
      Provides specified property value
      java.lang.String getProperty​(java.lang.String propertyName, java.lang.String defaultValue)
      Provides specified property value or default value if property is not defined
      java.lang.String getVcsName()
      Returns name of the corresponding version control.

      • Methods inherited from interface jetbrains.buildServer.log.Loggable

        describe

    • Field Detail

      • SECURE_PROPERTY_PREFIX

        @NonNls
static final java.lang.String SECURE_PROPERTY_PREFIX
        See Also:
        Constant Field Values

    • Method Detail

      • getId

        long getId()
        returns root internal id
        Returns:
        see above

      • getName

        @NotNull
java.lang.String getName()
        returns descriptive name of the vcs root
        Returns:
        see above

      • getVcsName

        @NotNull
java.lang.String getVcsName()
        Returns name of the corresponding version control.
        Returns:
        name of the corresponding version control

      • getProperties

        @NotNull
java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Returns mapping from a property name to its value
        Returns:
        map of all defined properties

      • getProperty

        @Nullable
java.lang.String getProperty​(@NotNull
                             java.lang.String propertyName)
        Provides specified property value
        Parameters:
        propertyName - name of the property whose value is requested
        Returns:
        value of a specified property

      • getProperty

        @Nullable
@Contract("_,null->null;_,!null->!null")
java.lang.String getProperty​(@NotNull
                             java.lang.String propertyName,
                             @Nullable
                             java.lang.String defaultValue)
        Provides specified property value or default value if property is not defined
        Parameters:
        propertyName - name of the property whose value is requested
        defaultValue - default value which is returned if property value was not specified explicitly
        Returns:
        - value of a specified property or 'defaultValue' if it is not defined

      • getExternalId

        @NotNull
java.lang.String getExternalId()
        Returns:
        External VCS Root ID in VCS services and on build agent. If unset (in tests, for instance), empty string is returned.
        Since:
        2021.2