Package jetbrains.buildServer.agent

Class AgentRuntimeProperties

    • Field Detail

      • ANT_TASK_EXTENSIONS

        public static final java.lang.String ANT_TASK_EXTENSIONS
        See Also:
        Constant Field Values

      • RUNTIME_PROPS_FILE

        public static final java.lang.String RUNTIME_PROPS_FILE
        This property contains path to properties file with runtime settings (extensions and their classpath). Currently AGENT_CLASSPATH & ANT_TASK_EXTENSIONS properties are stored there.
        See Also:
        Constant Field Values

      • BUILD_CHECKOUT_DIR

        public static final java.lang.String BUILD_CHECKOUT_DIR
        See Also:
        Constant Field Values

      • DEFAULT_CHECKOUT_DIR_PARAM_NAME

        public static final java.lang.String DEFAULT_CHECKOUT_DIR_PARAM_NAME
        See Also:
        Constant Field Values

      • BUILD_WORKING_DIR

        public static final java.lang.String BUILD_WORKING_DIR
        See Also:
        Constant Field Values

      • RELY_ON_VCS_TO_RESTORE_FROM_ERRORS

        public static final java.lang.String RELY_ON_VCS_TO_RESTORE_FROM_ERRORS
        When this configuration parameter is set, TeamCity won't mark checkout directory as dirty when agent-side checkout is used and a error has happened during such a checkout. I.e. in this case, it is up to VCS support to handle the problem with the checkout. See also: https://youtrack.jetbrains.com/issue/TW-41456
        Since:
        9.1.4, 10.0 enabled by default
        See Also:
        Constant Field Values

      • FAIL_ON_CLEAN_CHECKOUT

        public static final java.lang.String FAIL_ON_CLEAN_CHECKOUT
        This configuration parameter, when set to true, ensures that on dirty copy for a build, or on VcsSettings change, clean checkout won't be performed and the build will be failed instead. If property is set to 'ignoreAndContinue', the problem with dirty copy is ignored and build continue as if everything is OK
        Since:
        10.0
        See Also:
        Issue TW-33168, Constant Field Values

      • PARENT_FLOW_ID_ENV

        public static final java.lang.String PARENT_FLOW_ID_ENV
        See Also:
        Constant Field Values

      • TEAMCITY_INFO_XML

        public static final java.lang.String TEAMCITY_INFO_XML
        See Also:
        Constant Field Values

      • AGENT_BENCHMARK_ENABLED_PROPERTY

        public static final java.lang.String AGENT_BENCHMARK_ENABLED_PROPERTY
        See Also:
        Constant Field Values

      • AGENT_BENCHMARK_PROPERTY_NAME

        public static final java.lang.String AGENT_BENCHMARK_PROPERTY_NAME
        See Also:
        Constant Field Values

      • PROCESSORS_COUNT_KEY

        public static final java.lang.String PROCESSORS_COUNT_KEY
        See Also:
        Constant Field Values

      • JAVA_IO_TMPDIR_SYSTEM_PROPERTY

        public static final java.lang.String JAVA_IO_TMPDIR_SYSTEM_PROPERTY
        See Also:
        Constant Field Values

      • TEAMCITY_SERVER_URL

        public static final java.lang.String TEAMCITY_SERVER_URL
        See Also:
        Constant Field Values

      • TEAMCITY_AGENT_NAME

        public static final java.lang.String TEAMCITY_AGENT_NAME
        See Also:
        Constant Field Values

      • TEAMCITY_AGENT_HOME

        public static final java.lang.String TEAMCITY_AGENT_HOME
        See Also:
        Constant Field Values

      • TEAMCITY_AGENT_WORK

        public static final java.lang.String TEAMCITY_AGENT_WORK
        See Also:
        Constant Field Values

      • TEAMCITY_AGENT_TOOLS

        public static final java.lang.String TEAMCITY_AGENT_TOOLS
        See Also:
        Constant Field Values

      • TEAMCITY_AGENT_OWN_PORT

        public static final java.lang.String TEAMCITY_AGENT_OWN_PORT
        Since:
        8.0
        See Also:
        Constant Field Values

      • TEAMCITY_BUILD_STEP_NAME

        public static final java.lang.String TEAMCITY_BUILD_STEP_NAME
        Config parameter that contains current step name in format: AA (runType)
        Since:
        7.1
        See Also:
        Constant Field Values

      • AGENT_RUNNER_PARAMS_FILE_PROP

        public static final java.lang.String AGENT_RUNNER_PARAMS_FILE_PROP
        This property will contain the path to properties file containing all runner parameters Those properties are also stored to xml properties file. To use it, append '.xml' to the end of returned path.
        See Also:
        Constant Field Values

      • AGENT_CONFIGURATION_PARAMS_FILE_PROP

        public static final java.lang.String AGENT_CONFIGURATION_PARAMS_FILE_PROP
        This property will contain the path to properties file containing all configuration properties Those properties are also stored to xml properties file. To use it, append '.xml' to the end of returned path.
        See Also:
        Constant Field Values

      • AGENT_BUILD_PARAMS_FILE_PROP

        public static final java.lang.String AGENT_BUILD_PARAMS_FILE_PROP
        This property will contain the path to properties file containing all build parameters which starts with 'system.' prefix. 'system.' prefix is omitted. Those properties are also stored to xml properties file. To use it, append '.xml' to the end of returned path.
        See Also:
        Constant Field Values

      • AGENT_BUILD_PARAMS_FILE_ENV

        public static final java.lang.String AGENT_BUILD_PARAMS_FILE_ENV
        See Also:
        Constant Field Values

      • TEAMCITY_DEFAULT_PROPERTIES

        public static final java.lang.String TEAMCITY_DEFAULT_PROPERTIES
        1. Contains name of the optional properties file which is used to load build properties.
        2. Default name of the properties file in project root directory for the above.
        See Also:
        Constant Field Values

      • CHANGED_FILES_FILE_PARAM

        public static final java.lang.String CHANGED_FILES_FILE_PARAM
        Contains path to a file where information about changed files in the build is stored. Read more about file format in our documentation.
        See Also:
        Constant Field Values

      • AGENT_PRIORITY_PARAMETER

        public static final java.lang.String AGENT_PRIORITY_PARAMETER
        This property will contain the agent's priority. 'priority' is optional and only affects the order in which the agents are placed in the "available agents" collection.

        Valid priority range is [MIN_INTEGER, MAX_INTEGER]. The higher the value, the higher the priority. DEFAULT_AGENT_PRIORITY - 0.

        Since:
        2023.11
        See Also:
        Constant Field Values

      • DEFAULT_AGENT_PRIORITY

        public static final int DEFAULT_AGENT_PRIORITY
        Default agent priority. When AGENT_PRIORITY_PARAMETER is not set, this value is used.
        See Also:
        Constant Field Values

      • MAX_AGENT_PRIORITY

        public static final int MAX_AGENT_PRIORITY
        Maximum agent priority.
        Since:
        2023.11
        See Also:
        Constant Field Values

      • MIN_AGENT_PRIORITY

        public static final int MIN_AGENT_PRIORITY
        Minimum agent priority.
        Since:
        2023.11
        See Also:
        Constant Field Values

      • TEAMCITY_INTERNAL_PARAMETER_PREFIX

        public static final java.lang.String TEAMCITY_INTERNAL_PARAMETER_PREFIX
        Special prefix for internal configuration parameters (see TW-59896)
        Since:
        2019.1
        See Also:
        Constant Field Values

      • PROPERTIES

        public static final java.lang.String[] PROPERTIES

      • AGENT_SPECIFIC_REFERABLE_PARAMS

        public static final java.lang.String[] AGENT_SPECIFIC_REFERABLE_PARAMS

      • ENSURE_FREE_SPACE_KEY

        public static final java.lang.String ENSURE_FREE_SPACE_KEY
        Agent configuration parameter to ensure free disk space before the build start
        Since:
        6.5
        See Also:
        Constant Field Values

      • ENSURE_FREE_TEMP_SPACE_KEY

        public static final java.lang.String ENSURE_FREE_TEMP_SPACE_KEY
        See Also:
        Constant Field Values

      • ENSURE_FREE_SYSTEM_SPACE_KEY

        public static final java.lang.String ENSURE_FREE_SYSTEM_SPACE_KEY
        See Also:
        Constant Field Values

    • Method Detail

      • getBuildId

        public static java.lang.String getBuildId()

      • getBuildWorkingDir

        public static java.lang.String getBuildWorkingDir​(java.util.Map runnerParameters)

      • getCheckoutDir

        public static java.lang.String getCheckoutDir​(java.util.Map runParameters)

      • getOwnPort

        public static int getOwnPort()