BuildSettings (javadoc 2024.12-174331 API)

All Superinterfaces:

ReadOnlyBuildSettings, ReadOnlyUserParameters

All Known Implementing Classes:

AbstractBuildSettings, CachingBuildSettings, ExtensibleBuildSettings, PromotionBuildSettings
```
public interface BuildSettings
extends ReadOnlyBuildSettings
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SBuildStepsCollection`	`getAllBuildRunners()`
`Collection<? extends SBuildStepDescriptor>`	`getBuildRunners()`	Returns enabled build runners.
`ReadOnlyOptionSupport`	`getOptions()`	Build options.
`ReadOnlyBuildTypeSettings`	`getParentSettings()`
`Map<String,SettingDescription>`	`getReferencedParameters()`
`Map<String,SettingDescription>`	`getUndefinedParameters()`	Computes all undefined parameters based on current settings.

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyBuildSettings
getArtifactDependencies, getArtifactPaths, getBuildFeatures, getBuildFeaturesOfType, getBuildFeaturesRequirements, getBuildNumberPattern, getCheckoutDirectory, getCheckoutType, getDigest, getLabelPattern, getOption, getParametersAvailableOnAgents, getParametersProvider, getRequirements, getRunnersRequirements, getVcsRootEntries, isCompositeBuild

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyUserParameters
getParameter, getParameters, getParametersCollection, getParameterValue

- Method Detail
  - getBuildRunners
```
@NotNull
Collection<? extends SBuildStepDescriptor> getBuildRunners()
```
    Description copied from interface: ReadOnlyBuildSettings
    
    Returns enabled build runners.
    
    Specified by:
    
    getBuildRunners in interface ReadOnlyBuildSettings
    
    Returns:
    
    build runners in the defined order.
  - getAllBuildRunners
```
@NotNull
SBuildStepsCollection getAllBuildRunners()
```
    Returns:
    
    preprocessed with extensions collection of build runners
    
    Since:
    
    8.0
  - getOptions
```
@NotNull
ReadOnlyOptionSupport getOptions()
```
    Build options.
    
    Returns:
    
    see above
  - getUndefinedParameters
```
@NotNull
Map<String,SettingDescription> getUndefinedParameters()
```
    Computes all undefined parameters based on current settings. Parameter is undefined if there is a reference to it in any of build settings and available parameters collection does not contain it.
    
    Returns:
    
    see above
  - getReferencedParameters
```
@NotNull
Map<String,SettingDescription> getReferencedParameters()
```
    Returns:
    
    all referenced parameters with description of the place where reference to parameter is specified.
  - getParentSettings
```
@NotNull
ReadOnlyBuildTypeSettings getParentSettings()
```
    Returns:
    
    original build type settings used as base object for this build settings instance.