Interface BuildAttributes


  • public interface BuildAttributes
    • Field Detail

      • CLEAN_SOURCES

        static final String CLEAN_SOURCES
        Indicates that build needs to perform clean checkout, possible values are: true / false.
        See Also:
        Constant Field Values
      • COLLECT_CHANGES_ERROR

        static final String COLLECT_CHANGES_ERROR
        If process of changes collecting failed for this build, contains error message of the changes collector
        See Also:
        Constant Field Values
      • HAS_FROZEN_SETTINGS

        static final String HAS_FROZEN_SETTINGS
        Indicates whether the build has frozen settings. Before TeamCity 10.0 possible values were 'true' if settings are frozen, 'false' if attempt to freeze settings failed, and null if settings are not frozen. The only requestor of settings freeze was versioned settings subsystem.

        Since TeamCity 10.0 attribute's value is an origin of build settings. Well known values are 'vcs' if settings come from VCS, 'current' if current buildType's settings were frozen in build, 'false' if attempt to freeze settings failed, null means no attempt to freeze settings was performed. Value 'true' in old builds treated as 'vcs' in order to not write a converter.

        See Also:
        Constant Field Values
      • FORCE_POSTPROCES_SETTINGS

        static final String FORCE_POSTPROCES_SETTINGS
        Indicated whether postpocessors should be executed for the build settings even when settings are marked as frozen.

        In case the attribute has any other value ('false', null), postprocessors are executed only if the settings should be frozen. So postprocessors are executed if build freeze is needed or attribute 'teamcity.build.forceCallPostprocess' has value 'true'.

        The attribute is always cleared after postprocessors are executed.

        See Also:
        Constant Field Values
      • FREEZE_SETTINGS

        static final String FREEZE_SETTINGS
        Indicates whether settings should be frozen in build, when a promotion doesn't have such an attribute, buildType defaults should be used
        See Also:
        Constant Field Values
      • FREEZE_REQUIRES_COLLECTED_CHANGES

        static final String FREEZE_REQUIRES_COLLECTED_CHANGES
        Indicates whether the build should wait for checking for changes before freezing the build settings. Note: in this case the checking for changes will be performed while the build sits in the queue even if the build is not a part of a build chain.
        Since:
        2023.05
        See Also:
        Constant Field Values
      • BUILD_TYPE_ARTIFACTS_PATH

        static final String BUILD_TYPE_ARTIFACTS_PATH
        The full build artifacts path is the following: {artifacts root directory}/{project external id}/{build type name}/{build id} This attribute contains only the following part of the full path: {project external id}/{build type name}
        Since:
        10.0
        See Also:
        Constant Field Values
      • BUILD_OWNER_NODE_URL

        static final String BUILD_OWNER_NODE_URL
        Contains URL of a build messages processor which handles messages produced by this build
        Since:
        10.0
        See Also:
        Constant Field Values
      • CHECKOUT_PROPERTIES_HASH

        static final String CHECKOUT_PROPERTIES_HASH
        Contains a string hash of the current state of server checkout properties, used to find out if VCS Root has changed when calculating promotion equivalence
        Since:
        2017.1
        See Also:
        Constant Field Values
      • HAS_EXTERNAL_ARTIFACTS

        static final String HAS_EXTERNAL_ARTIFACTS
        Boolean attribute indicating that a build has artifacts stored in an external system (S3)
        Since:
        2022.02
        See Also:
        Constant Field Values
      • SETTINGS_DIGEST

        static final String SETTINGS_DIGEST
        Contains digest of settings of this build. This is the same digest which is stored under the build hidden artifacts in file: .teamcity/settings/digest.txt Purpose of this attribute is to avoid performance issues when digest should be retrieved from disk for many build promotions.
        Since:
        2017.1
        See Also:
        Constant Field Values
      • COMPOSITE_BUILD

        static final String COMPOSITE_BUILD
        Boolean attribute indicating that a build is composite
        Since:
        2017.2
        See Also:
        Constant Field Values
      • BUILD_DETACHED_FROM_AGENT_AT_STEP

        static final String BUILD_DETACHED_FROM_AGENT_AT_STEP
        Id of the last step executed on the agent before the build was detached from the agent
        Since:
        2019.2
        See Also:
        Constant Field Values
      • BUILD_DETACHED_FROM_AGENT_RUNNER_TYPE

        static final String BUILD_DETACHED_FROM_AGENT_RUNNER_TYPE
        Id of the last step executed on the agent before the build was detached from the agent
        Since:
        2021.1
        See Also:
        Constant Field Values
      • BUILD_DETACHED_FROM_AGENT_RECEIVED_TIME

        static final String BUILD_DETACHED_FROM_AGENT_RECEIVED_TIME
        Timestamp on server when this build received detached from agent command from agent
        Since:
        2020.2
        See Also:
        Constant Field Values
      • BUILD_DETACHED_FROM_AGENT_TIME

        static final String BUILD_DETACHED_FROM_AGENT_TIME
        Timestamp on server when this build was detached from agent
        Since:
        2020.2
        See Also:
        Constant Field Values
      • BUILD_DETACHED_FROM_AGENT_TRACKING_INFO

        static final String BUILD_DETACHED_FROM_AGENT_TRACKING_INFO
        Timestamp on server when this build was detached from agent
        Since:
        2021.1
        See Also:
        Constant Field Values
      • BUILD_CUSTOMIZED

        static final String BUILD_CUSTOMIZED
        Marker of a customized build, i.e. the build which has custom parameters, revisions, dependencies. Contains a string value like 'params', 'mod_id', or 'params|mod_id'
        Since:
        2020.2
        See Also:
        Constant Field Values
      • CREATOR_NODE_ID

        static final String CREATOR_NODE_ID
        Id of node which created the build promotion
        Since:
        2020.1
        See Also:
        Constant Field Values
      • AGENT_LESS_BUILD

        static final String AGENT_LESS_BUILD
        Boolean attribute indicating that a build is agent-less
        Since:
        2020.2
        See Also:
        Constant Field Values
      • AGENT_LESS_BUILD_EXECUTOR

        static final String AGENT_LESS_BUILD_EXECUTOR
        Name of the executor associated with a non-composite agentless build
        Since:
        2023.07
        See Also:
        Constant Field Values
      • AGENT_LESS_BUILD_EXECUTOR_PROFILE_ID

        static final String AGENT_LESS_BUILD_EXECUTOR_PROFILE_ID
        ID of the executor that is executing a non-composite agentless executor build
        Since:
        2024.12
        See Also:
        Constant Field Values
      • PERSONAL_PATCH_APPLICABLE

        static final String PERSONAL_PATCH_APPLICABLE
        Boolean attribute which can be either not specified or set to "false". If set to false then a personal patch associated with the current personal build should be ignored when build starts on an agent.
        Since:
        2021.1.2
        See Also:
        Constant Field Values
      • SERVER_BUILD_NUMBER

        static final String SERVER_BUILD_NUMBER
        A build number of the server which created this build.
        Since:
        2022.04
        See Also:
        Constant Field Values
      • ANCHOR_ID

        static final String ANCHOR_ID
        If the build promotion is auto-generated, then this attribute has an id of the build promotion which created it, for instance, in case of a matrix build, or parallel tests, this is the id of the composite build which has links to all other parts. In case of pipelines, this id is an id of the pipeline head.
        Since:
        2024.07
        See Also:
        Constant Field Values
      • ARCHIVED_TESTS_NUMBER

        static final String ARCHIVED_TESTS_NUMBER
        An integer attribute indicating that the build tests have been archived. A positive value represents the number of tests moved to the archive. A zero value means that there were no tests associated with the build.
        See Also:
        Constant Field Values
      • TEAMCITY_SCHEDULED_TIME_ATTRIBUTE

        static final String TEAMCITY_SCHEDULED_TIME_ATTRIBUTE
        Contains the earliest time when the build can start
        Since:
        2023.11
        See Also:
        Constant Field Values
      • TEAMCITY_SKIPPED

        static final String TEAMCITY_SKIPPED
        Used to mark builds as skipped, i.e. those which should be totally ignored when dependency status is analyzed
        Since:
        2024.12
        See Also:
        Constant Field Values
      • TEAMCITY_BUILD_CACHE_STATUS_ATTRIBUTE

        static final String TEAMCITY_BUILD_CACHE_STATUS_ATTRIBUTE
        An attribute containing the build cache status if the build utilizes a build cache. The value could be null if the build doesn't utilize the build cache or for old builds with build cache, before adding this attribute. Otherwise, it contains one of the following values: BuildCacheStatus
        Since:
        2024.07
        See Also:
        Constant Field Values
      • AVAILABLE_FEATURE_TYPES

        static final String AVAILABLE_FEATURE_TYPES
        Contains a comma separated list of build feature types stored in this build settings. The attribute is initialized during the settings freeze.
        Since:
        2024.12
        See Also:
        Constant Field Values