BuildTypeOptions

All Superinterfaces:

OptionSupport

All Known Subinterfaces:

BuildTypeSettings, BuildTypeTemplate, RemoteBuildType, SBuildType
```
public interface BuildTypeOptions
extends OptionSupport
```
Contains constants for build configuration options.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class BuildTypeOptions.BuildConfigurationType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BuildTypeOptions.BuildConfigurationType`

Field Summary

Fields
Modifier and Type	Field and Description
`static Option<java.lang.Boolean>`	`BT_ALLOW_EXTERNAL_STATUS` If true, viewing of the configuration status is allowed externally.
`static Option<java.lang.Boolean>`	`BT_ALLOW_PERSONAL_BUILD_TRIGGERING` Controls whether personal builds can be triggered in this build configuration.
`static EnumOption<PublishArtifactCondition>`	`BT_ARTIFACT_PUBLISH_CONDITION` Artifact publishing condition
`static Option<java.lang.String>`	`BT_ARTIFACT_RULES` Artifact publishing rules.
`static Option<java.lang.String>`	`BT_BRANCH_FILTER` Branch filter for logical branch names in this configuration: allows to limit branches visible in this configuration.
`static Option<java.lang.String>`	`BT_BUILD_CONFIGURATION_TYPE` Contains the type of the build configuration.
`static Option<java.lang.Boolean>`	`BT_BUILD_DEFAULT_BRANCH` Deprecated. not used since 2019.1, use `BT_BRANCH_FILTER` instead
`static Option<java.lang.String>`	`BT_BUILD_NUMBER_PATTERN` Build number pattern
`static Option<java.lang.String>`	`BT_CHECKOUT_DIR` Checkout directory.
`static Option<java.lang.String>`	`BT_CHECKOUT_MODE` Preferred checkout type, can have values from jetbrains.buildServer.BuildTypeDescriptor#CheckoutType Actual checkout type can be different, for example, if ON_AGENT checkout type is set, but one of VCS roots does not support it, actual checkout type will be switched to ON_SERVER.
`static Option<java.lang.Boolean>`	`BT_CLEAN_BUILD` If true, all files on an agent machine should be deleted before the build is started.
`static Option<java.lang.Boolean>`	`BT_EXCLUDE_DEFAULT_BRANCH_CHANGES` Whether changes reachable from the default branch should be excluded from other branches
`static Option<java.lang.Integer>`	`BT_EXECUTION_TIMEOUT` Allows to set max build execution time (in minutes).
`static Option<java.lang.Boolean>`	`BT_FAIL_IF_TESTS_FAIL` If true, build will fail if there is at least one failed test.
`static Option<java.lang.Boolean>`	`BT_FAIL_ON_ANY_ERROR_MESSAGE` If true, build will fail if any error message is received from logger.
`static Option<java.lang.Boolean>`	`BT_FAIL_ON_EXIT_CODE` If true, build will fail if build process exit code was non-zero
`static Option<java.lang.Boolean>`	`BT_FAIL_ON_OOME_OR_CRASH` If true then build will be marked as failed if out of memory error or process crash is detected.
`static Option<java.lang.Boolean>`	`BT_HANGING_BUILDS_DETECTION_ENABLED` Enables or disables hanging builds detection in this build configuration
`static Option<java.lang.Integer>`	`BT_MAX_RUNNING_BUILDS` Allows to set maximum number of simultaneously running builds.
`static Option<java.lang.Boolean>`	`BT_SHOW_DEPS_CHANGES` If true, build will include snapshot dependencies changes when reporting changes on UI
`static java.lang.String`	`DEFAULT_BUILD_NUMBER_PATTERN`
`static java.lang.String`	`DEFAULT_VCS_LABELING_BRANCH_FILTER`
`static Option<java.lang.String>`	`VCS_LABELING_BRANCH_FILTER` Deprecated. since 10.0, vcs labeling is a build feature, no a build option

Method Summary
- Methods inherited from interface jetbrains.buildServer.util.OptionSupport
  getChangedOptions, getDeclaredOption, getOption, getOptionDefaultValue, getOptions, getOwnOptions, setOption

- Field Detail
  - BT_CLEAN_BUILD
```
static final Option<java.lang.Boolean> BT_CLEAN_BUILD
```
    If true, all files on an agent machine should be deleted before the build is started.
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_FAIL_IF_TESTS_FAIL
```
static final Option<java.lang.Boolean> BT_FAIL_IF_TESTS_FAIL
```
    If true, build will fail if there is at least one failed test.
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_ALLOW_EXTERNAL_STATUS
```
static final Option<java.lang.Boolean> BT_ALLOW_EXTERNAL_STATUS
```
    If true, viewing of the configuration status is allowed externally.
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_EXECUTION_TIMEOUT
```
static final Option<java.lang.Integer> BT_EXECUTION_TIMEOUT
```
    Allows to set max build execution time (in minutes). If this time is exceeded, build fails. Default value is 0 - means there is no limit in build execution time
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_MAX_RUNNING_BUILDS
```
static final Option<java.lang.Integer> BT_MAX_RUNNING_BUILDS
```
    Allows to set maximum number of simultaneously running builds. 0 means there is no limit on a number of running builds.
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_FAIL_ON_ANY_ERROR_MESSAGE
```
static final Option<java.lang.Boolean> BT_FAIL_ON_ANY_ERROR_MESSAGE
```
    If true, build will fail if any error message is received from logger.
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_FAIL_ON_EXIT_CODE
```
static final Option<java.lang.Boolean> BT_FAIL_ON_EXIT_CODE
```
    If true, build will fail if build process exit code was non-zero
    
    See Also:
    
    OptionSupport.getOption(jetbrains.buildServer.util.Option<T>)
  - BT_FAIL_ON_OOME_OR_CRASH
```
static final Option<java.lang.Boolean> BT_FAIL_ON_OOME_OR_CRASH
```
    If true then build will be marked as failed if out of memory error or process crash is detected.
  - BT_HANGING_BUILDS_DETECTION_ENABLED
```
static final Option<java.lang.Boolean> BT_HANGING_BUILDS_DETECTION_ENABLED
```
    Enables or disables hanging builds detection in this build configuration
  - DEFAULT_BUILD_NUMBER_PATTERN
```
static final java.lang.String DEFAULT_BUILD_NUMBER_PATTERN
```
    See Also:
    
    Constant Field Values
  - BT_BUILD_NUMBER_PATTERN
```
static final Option<java.lang.String> BT_BUILD_NUMBER_PATTERN
```
    Build number pattern
  - BT_SHOW_DEPS_CHANGES
```
static final Option<java.lang.Boolean> BT_SHOW_DEPS_CHANGES
```
    If true, build will include snapshot dependencies changes when reporting changes on UI
  - BT_BRANCH_FILTER
```
static final Option<java.lang.String> BT_BRANCH_FILTER
```
    Branch filter for logical branch names in this configuration: allows to limit branches visible in this configuration. Applied to local branches (coming from build configuration VCS roots) as well as to branches from snapshot dependencies.
    
    Since:
    
    2019.1
  - DEFAULT_VCS_LABELING_BRANCH_FILTER
```
static final java.lang.String DEFAULT_VCS_LABELING_BRANCH_FILTER
```
    See Also:
    
    Constant Field Values
  - VCS_LABELING_BRANCH_FILTER
```
@Deprecated
static final Option<java.lang.String> VCS_LABELING_BRANCH_FILTER
```
    Deprecated. since 10.0, vcs labeling is a build feature, no a build option
    
    Vcs labeling is done only for builds with branches matched by this filter
  - BT_ARTIFACT_RULES
```
static final Option<java.lang.String> BT_ARTIFACT_RULES
```
    Artifact publishing rules.
    
    Since:
    
    8.1
  - BT_ARTIFACT_PUBLISH_CONDITION
```
static final EnumOption<PublishArtifactCondition> BT_ARTIFACT_PUBLISH_CONDITION
```
    Artifact publishing condition
    
    Since:
    
    2019.1
  - BT_CHECKOUT_MODE
```
static final Option<java.lang.String> BT_CHECKOUT_MODE
```
    Preferred checkout type, can have values from jetbrains.buildServer.BuildTypeDescriptor#CheckoutType Actual checkout type can be different, for example, if ON_AGENT checkout type is set, but one of VCS roots does not support it, actual checkout type will be switched to ON_SERVER.
    
    Since:
    
    8.1
  - BT_CHECKOUT_DIR
```
static final Option<java.lang.String> BT_CHECKOUT_DIR
```
    Checkout directory.
    
    Since:
    
    8.1
  - BT_ALLOW_PERSONAL_BUILD_TRIGGERING
```
static final Option<java.lang.Boolean> BT_ALLOW_PERSONAL_BUILD_TRIGGERING
```
    Controls whether personal builds can be triggered in this build configuration.
    
    Since:
    
    9.1
  - BT_EXCLUDE_DEFAULT_BRANCH_CHANGES
```
static final Option<java.lang.Boolean> BT_EXCLUDE_DEFAULT_BRANCH_CHANGES
```
    Whether changes reachable from the default branch should be excluded from other branches
    
    Since:
    
    2017.1
  - BT_BUILD_DEFAULT_BRANCH
```
static final Option<java.lang.Boolean> BT_BUILD_DEFAULT_BRANCH
```
    Deprecated. not used since 2019.1, use BT_BRANCH_FILTER instead
    
    Whether builds in the default branch are allowed and the default branch is shown in UI
    
    Since:
    
    2017.1
  - BT_BUILD_CONFIGURATION_TYPE
```
static final Option<java.lang.String> BT_BUILD_CONFIGURATION_TYPE
```
    Contains the type of the build configuration. Possible values are: REGULAR, COMPOSITE and DEPLOYMENT.
    
    Since:
    
    2017.2

Interface BuildTypeOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface jetbrains.buildServer.util.OptionSupport

Field Detail

BT_CLEAN_BUILD

BT_FAIL_IF_TESTS_FAIL

BT_ALLOW_EXTERNAL_STATUS

BT_EXECUTION_TIMEOUT

BT_MAX_RUNNING_BUILDS

BT_FAIL_ON_ANY_ERROR_MESSAGE

BT_FAIL_ON_EXIT_CODE

BT_FAIL_ON_OOME_OR_CRASH

BT_HANGING_BUILDS_DETECTION_ENABLED

DEFAULT_BUILD_NUMBER_PATTERN

BT_BUILD_NUMBER_PATTERN

BT_SHOW_DEPS_CHANGES

BT_BRANCH_FILTER

DEFAULT_VCS_LABELING_BRANCH_FILTER

VCS_LABELING_BRANCH_FILTER

BT_ARTIFACT_RULES

BT_ARTIFACT_PUBLISH_CONDITION

BT_CHECKOUT_MODE

BT_CHECKOUT_DIR

BT_ALLOW_PERSONAL_BUILD_TRIGGERING

BT_EXCLUDE_DEFAULT_BRANCH_CHANGES

BT_BUILD_DEFAULT_BRANCH

BT_BUILD_CONFIGURATION_TYPE