Package jetbrains.buildServer.serverSide

Interface ReadOnlyBuildSettings

All Superinterfaces:

ReadOnlyUserParameters

All Known Subinterfaces:

BuildSettings

All Known Implementing Classes:

AbstractBuildSettings, CachingBuildSettings, ExtensibleBuildSettings, PromotionBuildSettings

public interface ReadOnlyBuildSettings
extends ReadOnlyUserParameters

Frozen build settings for the build, which can be obtained from the build promotion.

Since:

2022.12

See Also:

BuildPromotion.getBuildSettings()

Method Summary

Modifier and Type	Method	Description
List<SArtifactDependency>	getArtifactDependencies()
String	getArtifactPaths()	Provides with build artifact paths.
Collection<SBuildFeatureDescriptor>	getBuildFeatures()	Returns enabled build features.
Collection<SBuildFeatureDescriptor>	getBuildFeaturesOfType(String featureType)	Returns unresolved enabled build features of specified type
List<Requirement>	getBuildFeaturesRequirements()
String	getBuildNumberPattern()
Collection<? extends SBuildRunnerDescriptor>	getBuildRunners()	Returns enabled build runners.
String	getCheckoutDirectory()	Returns build checkout directory - if specified explicitly.
BuildTypeDescriptor.CheckoutType	getCheckoutType()	Returns method used by agent to retrieve project sources.
byte[]	getDigest()	Returns digest of settings, i.e.
String	getLabelPattern()
<T> T	getOption(Option<T> option)
Map<String,String>	getParametersAvailableOnAgents()	The method returns map of parameters which will be available on the agents for the current build.
ParametersProvider	getParametersProvider()	Creates and returns a parameters provider, that provides with all parameters of this build and builds this one depends on.
List<Requirement>	getRequirements()	Get list of explicit requirements for build agents which can run this build configuration.
List<Requirement>	getRunnersRequirements()
List<VcsRootEntry>	getVcsRootEntries()	Returns VCS root entries associated with this build, i.e.
boolean	isCompositeBuild()

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyUserParameters

getParameter, getParameters, getParametersCollection, getParameterValue

Method Detail

getVcsRootEntries

@NotNull
List<VcsRootEntry> getVcsRootEntries()

Returns VCS root entries associated with this build, i.e. build configuration VCS root entries on the moment of build starting.

Returns:

see above

getCheckoutType

@NotNull
BuildTypeDescriptor.CheckoutType getCheckoutType()

Returns method used by agent to retrieve project sources. CheckoutType.ON_SERVER server creates patch and sends it to agent CheckoutType.ON_AGENT agent checks sources out CheckoutType.MANUAL script does it itself. This method returns actual checkout type, which may differ from the value set by #setCheckoutType(BuildTypeDescriptor.CheckoutType)

Returns:

method to get sources on agent.

getCheckoutDirectory

@Nullable
String getCheckoutDirectory()

Returns build checkout directory - if specified explicitly. Returns null if default checkout directory, generated by TeamCity should be used.

Returns:

build checkout directory

getArtifactDependencies

@NotNull
List<SArtifactDependency> getArtifactDependencies()

Returns:

list of artifact dependencies.

getBuildRunners

@NotNull
Collection<? extends SBuildRunnerDescriptor> getBuildRunners()

Returns enabled build runners.

Returns:

build runners in the defined order.

getBuildFeatures

@NotNull
Collection<SBuildFeatureDescriptor> getBuildFeatures()

Returns enabled build features.

Returns:

collection of enabled build features.

getBuildFeaturesOfType

@NotNull
Collection<SBuildFeatureDescriptor> getBuildFeaturesOfType(@NotNull
                                                           String featureType)

Returns unresolved enabled build features of specified type

Parameters:

featureType - feature type of interest

Returns:

see above

getOption

@NotNull
<T> T getOption(@NotNull
                Option<T> option)

getParametersProvider

@NotNull
ParametersProvider getParametersProvider()

Creates and returns a parameters provider, that provides with all parameters of this build and builds this one depends on.

getRequirements

@NotNull
List<Requirement> getRequirements()

Get list of explicit requirements for build agents which can run this build configuration. Explicit requirements are specified by user in Web UI explicitly.

Returns:

see above

getRunnersRequirements

@NotNull
List<Requirement> getRunnersRequirements()

Returns:

returns list of requirements imposed by runners.

Since:

2018.1

getBuildFeaturesRequirements

@NotNull
List<Requirement> getBuildFeaturesRequirements()

Returns:

returns list of requirements imposed by build features.

Since:

2019.1

getArtifactPaths

@Nullable
String getArtifactPaths()

Provides with build artifact paths. Artifact paths are comma separated paths to build artifacts. Support ant-style wildcards and target directories like *.zip => winFiles,unix/distro.tgz => linuxFiles, where winFiles and linuxFiles are target directories.

Returns:

build artifact paths

getLabelPattern

@NotNull
String getLabelPattern()

Returns:

Returns pattern to use for labeling

getParametersAvailableOnAgents

@NotNull
Map<String,String> getParametersAvailableOnAgents()

The method returns map of parameters which will be available on the agents for the current build. Note: for some parameters value can be unknown at the moment of the call, so for them empty values will be returned

Since:

2019.1.3

See Also:

BuildParametersProvider.getParametersAvailableOnAgent(SBuild)

getBuildNumberPattern

@NotNull
String getBuildNumberPattern()

Returns:

build number pattern

getDigest

@NotNull
byte[] getDigest()

Returns digest of settings, i.e. some hash describing the settings state. If hashes are different then settings are considered different too.

Returns:

see above

Since:

8.0

isCompositeBuild

boolean isCompositeBuild()

Returns:

true if these settings represent a composite build

Since:

2017.2