AgentRuntimeProperties

java.lang.Object
- jetbrains.buildServer.agent.AgentRuntimeProperties

public class AgentRuntimeProperties
extends java.lang.Object

See Also:: ServerProvidedProperties

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AGENT_BENCHMARK_PROPERTY_NAME`
`static java.lang.String`	`AGENT_BUILD_PARAMS_FILE_ENV`
`static 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.
`static java.lang.String`	`AGENT_CLASSPATH`
`static 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.
`static java.lang.String`	`AGENT_HOME_DIR`
`static java.lang.String`	`AGENT_NAME`
`static 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.
`static java.lang.String[]`	`AGENT_SPECIFIC_REFERABLE_PARAMS`
`static java.lang.String`	`AGENT_WORK_DIR`
`static java.lang.String`	`ANT_TASK_EXTENSIONS`
`static java.lang.String`	`ARTIFACTS_PATHS`
`static java.lang.String`	`BUILD_CHECKOUT_DIR`
`static java.lang.String`	`BUILD_ID`
`static java.lang.String`	`BUILD_TEMP_DIR`
`static java.lang.String`	`BUILD_TYPE_ID`
`static java.lang.String`	`BUILD_WORKING_DIR`
`static java.lang.String`	`CHANGED_FILES_FILE_PARAM` Contains path to a file where information about changed files in the build is stored.
`static java.lang.String`	`DEFAULT_CHECKOUT_DIR_PARAM_NAME`
`static java.lang.String`	`ENSURE_FREE_SPACE_KEY` Agent configuration parameter to ensure free disk space before the build start
`static java.lang.String`	`ENSURE_FREE_SYSTEM_SPACE_KEY`
`static java.lang.String`	`ENSURE_FREE_TEMP_SPACE_KEY`
`static java.lang.String`	`FAIL_EXIT_CODE`
`static 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.
`static java.lang.String`	`FLOW_ID_ENV`
`static java.lang.String`	`FLOW_ID_PROP`
`static java.lang.String`	`HOSTNAME`
`static java.lang.String`	`JAVA_IO_TMPDIR_SYSTEM_PROPERTY`
`static java.lang.String`	`OWN_PORT`
`static java.lang.String`	`PARENT_FLOW_ID_ENV`
`static java.lang.String[]`	`PROPERTIES`
`static 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.
`static java.lang.String`	`RUNTIME_PROPS_FILE` This property contains path to properties file with runtime settings (extensions and their classpath).
`static java.lang.String`	`TEAMCITY_AGENT_HOME`
`static java.lang.String`	`TEAMCITY_AGENT_NAME`
`static java.lang.String`	`TEAMCITY_AGENT_OWN_PORT`
`static java.lang.String`	`TEAMCITY_AGENT_TOOLS`
`static java.lang.String`	`TEAMCITY_AGENT_WORK`
`static java.lang.String`	`TEAMCITY_BUILD_STEP_NAME` Config parameter that contains current step name in format: AA (runType)
`static java.lang.String`	`TEAMCITY_DEFAULT_PROPERTIES` Contains name of the optional properties file which is used to load build properties.
`static java.lang.String`	`TEAMCITY_INFO_XML`
`static java.lang.String`	`TEAMCITY_INTERNAL_PARAMETER_PREFIX` Special prefix for internal configuration parameters (see TW-59896)
`static java.lang.String`	`TEAMCITY_SERVER_URL`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getBuildId()`
`static java.lang.String`	`getBuildWorkingDir(java.util.Map runnerParameters)`
`static java.lang.String`	`getCheckoutDir(java.util.Map runParameters)`
`static int`	`getOwnPort()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BUILD_ID
```
public static final java.lang.String BUILD_ID
```
    See Also:
    
    Constant Field Values
  - BUILD_TYPE_ID
```
public static final java.lang.String BUILD_TYPE_ID
```
    See Also:
    
    Constant Field Values
  - OWN_PORT
```
public static final java.lang.String OWN_PORT
```
    See Also:
    
    Constant Field Values
  - AGENT_CLASSPATH
```
public static final java.lang.String AGENT_CLASSPATH
```
    See Also:
    
    Constant Field Values
  - 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
  - BUILD_TEMP_DIR
```
public static final java.lang.String BUILD_TEMP_DIR
```
    See Also:
    
    Constant Field Values
  - FAIL_EXIT_CODE
```
public static final java.lang.String FAIL_EXIT_CODE
```
    See Also:
    
    Constant Field Values
  - HOSTNAME
```
public static final java.lang.String HOSTNAME
```
    Since:
    
    10.0
    
    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
  - AGENT_HOME_DIR
```
public static final java.lang.String AGENT_HOME_DIR
```
    See Also:
    
    Constant Field Values
  - AGENT_WORK_DIR
```
public static final java.lang.String AGENT_WORK_DIR
```
    See Also:
    
    Constant Field Values
  - AGENT_NAME
```
public static final java.lang.String AGENT_NAME
```
    See Also:
    
    Constant Field Values
  - FLOW_ID_ENV
```
public static final java.lang.String FLOW_ID_ENV
```
    See Also:
    
    Constant Field Values
  - FLOW_ID_PROP
```
public static final java.lang.String FLOW_ID_PROP
```
    See Also:
    
    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_PROPERTY_NAME
```
public static final java.lang.String AGENT_BENCHMARK_PROPERTY_NAME
```
    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
  - 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
```
  - ARTIFACTS_PATHS
```
public static final java.lang.String ARTIFACTS_PATHS
```
    See Also:
    
    Constant Field Values
  - 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()
```

Class AgentRuntimeProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUILD_ID

BUILD_TYPE_ID

OWN_PORT

AGENT_CLASSPATH

ANT_TASK_EXTENSIONS

RUNTIME_PROPS_FILE

BUILD_CHECKOUT_DIR

DEFAULT_CHECKOUT_DIR_PARAM_NAME

BUILD_WORKING_DIR

BUILD_TEMP_DIR

FAIL_EXIT_CODE

HOSTNAME

RELY_ON_VCS_TO_RESTORE_FROM_ERRORS

FAIL_ON_CLEAN_CHECKOUT

AGENT_HOME_DIR

AGENT_WORK_DIR

AGENT_NAME

FLOW_ID_ENV

FLOW_ID_PROP

PARENT_FLOW_ID_ENV

TEAMCITY_INFO_XML

AGENT_BENCHMARK_PROPERTY_NAME

JAVA_IO_TMPDIR_SYSTEM_PROPERTY

TEAMCITY_SERVER_URL

TEAMCITY_AGENT_NAME

TEAMCITY_AGENT_HOME

TEAMCITY_AGENT_WORK

TEAMCITY_AGENT_TOOLS

TEAMCITY_AGENT_OWN_PORT

TEAMCITY_BUILD_STEP_NAME

AGENT_RUNNER_PARAMS_FILE_PROP

AGENT_CONFIGURATION_PARAMS_FILE_PROP

AGENT_BUILD_PARAMS_FILE_PROP

AGENT_BUILD_PARAMS_FILE_ENV

TEAMCITY_DEFAULT_PROPERTIES

CHANGED_FILES_FILE_PARAM

TEAMCITY_INTERNAL_PARAMETER_PREFIX

PROPERTIES

AGENT_SPECIFIC_REFERABLE_PARAMS

ARTIFACTS_PATHS

ENSURE_FREE_SPACE_KEY

ENSURE_FREE_TEMP_SPACE_KEY

ENSURE_FREE_SYSTEM_SPACE_KEY

Method Detail

getBuildId

getBuildWorkingDir

getCheckoutDir

getOwnPort