Package jetbrains.buildServer

Interface BuildTypeDescriptor

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FULL_NAME_SEPARATOR
      Full name separator

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBuildTypeId()
      Returns build configuration internal id.
      BuildTypeDescriptor.CheckoutType getCheckoutType()
      Returns method used by agent to retrieve project sources.
      java.lang.String getDescription()
      Returns configuration description.
      java.lang.String getExternalId()
      External id of this build configuration.
      java.lang.String getFullName()
      Returns name in the form: <parent project name> / <parent project name> / ...
      java.lang.String getName()
      Returns presentable name.
      java.lang.String getProjectExternalId()
      Returns external id of the project this build configuration configured in.
      java.lang.String getProjectId()
      Returns internal id of the project this build configuration configured in.
      java.lang.String getProjectName()
      Returns project name this configuration belongs to.
      java.util.Collection<java.lang.String> getRunnerTypes()
      Returns collection of types of enabled build runners configured in this configuration
      boolean isPaused()
      Returns if the configuration is paused.
      boolean isPersonal()
      Returns if the configuration is temporary created for the personal build.

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Method Detail

      • getBuildTypeId

        @NotNull
java.lang.String getBuildTypeId()
        Returns build configuration internal id. Cannot be changed.
        Returns:
        unique id

      • getExternalId

        @NotNull
java.lang.String getExternalId()
        External id of this build configuration. This identifier is unique in all build configurations and build templates scope.
        Returns:
        the external identifier of this build configuration.
        Since:
        8.0

      • getProjectName

        @NotNull
java.lang.String getProjectName()
        Returns project name this configuration belongs to.
        Returns:
        parent project name.

      • getName

        java.lang.String getName()
        Returns presentable name. Can be changed by the user.
        Returns:
        presentable name

      • getFullName

        java.lang.String getFullName()
        Returns name in the form: <parent project name> / <parent project name> / ... / <project name> / <build type name>
        Returns:
        see above

      • getDescription

        java.lang.String getDescription()
        Returns configuration description.
        Returns:
        configuration description.

      • getRunnerTypes

        java.util.Collection<java.lang.String> getRunnerTypes()
        Returns collection of types of enabled build runners configured in this configuration
        Returns:
        see above

      • isPersonal

        boolean isPersonal()
        Returns if the configuration is temporary created for the personal build.
        Returns:
        true if configuration was created to run some personal changes. Such sort of configurations are not available from an administrative interface, only for internal usage.

      • getCheckoutType

        BuildTypeDescriptor.CheckoutType getCheckoutType()
        Returns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself.
        Returns:
        method to get sources on agent.

      • isPaused

        boolean isPaused()
        Returns if the configuration is paused.
        Returns:
        true is build is paused. In this state build can be added to queue manually only, all other triggers are disabled.

      • getProjectId

        @NotNull
java.lang.String getProjectId()
        Returns internal id of the project this build configuration configured in.
        Returns:
        parent project internal id.

      • getProjectExternalId

        @NotNull
java.lang.String getProjectExternalId()
        Returns external id of the project this build configuration configured in.
        Returns:
        parent project external id.
        Since:
        8.0