Package jetbrains.buildServer

Interface BuildTypeDescriptor

All Superinterfaces:

Comparable<BuildTypeDescriptor>

All Known Subinterfaces:

BuildType, BuildTypeEx, QueuedBuildEx, RemoteBuildType, RemoteBuildTypeEx, SBuildType

All Known Implementing Classes:

BuildTypeImpl, DummyBuildType, EditableBuildTypeCopy, MockBuildType, QueuedBuildImpl, RemoteBuildTypeImpl, SecuredBuildType, SecuredQueuedBuild

public interface BuildTypeDescriptor
extends Comparable<BuildTypeDescriptor>

General build configuration data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BuildTypeDescriptor.CheckoutType	Possible modes of check out process.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FULL_NAME_SEPARATOR	Full name separator

Method Summary

Modifier and Type	Method	Description
String	getBuildTypeId()	Returns build configuration internal id.
BuildTypeDescriptor.CheckoutType	getCheckoutType()	Returns method used by agent to retrieve project sources.
String	getDescription()	Returns configuration description.
String	getExternalId()	External id of this build configuration.
String	getFullName()	Returns name in the form: <parent project name> / <parent project name> / ...
String	getName()	Returns presentable name.
String	getProjectExternalId()	Returns external id of the project this build configuration configured in.
String	getProjectId()	Returns internal id of the project this build configuration configured in.
String	getProjectName()	Returns project name this configuration belongs to.
Collection<String>	getRunnerTypes()	Returns collection of types of enabled build runners configured in this configuration
boolean	isPaused()	Returns if the configuration is paused.
boolean	isPersonal()	Returns if the configuration is temporary created for the personal build.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

FULL_NAME_SEPARATOR

@NotNull
static final String FULL_NAME_SEPARATOR

Full name separator

Since:

8.0

See Also:

getFullName(), Constant Field Values

Method Detail

getBuildTypeId

@NotNull
String getBuildTypeId()

Returns build configuration internal id. Cannot be changed.

Returns:

unique id

getExternalId

@NotNull
String getExternalId()

External id of this build configuration. This identifier is unique in all build configurations and build templates scope.

Returns:

the external identifier of this build configuration.

Since:

8.0

getProjectName

@NotNull
String getProjectName()

Returns project name this configuration belongs to.

Returns:

parent project name.

getName

String getName()

Returns presentable name. Can be changed by the user.

Returns:

presentable name

getFullName

String getFullName()

Returns name in the form: <parent project name> / <parent project name> / ... / <project name> / <build type name>

Returns:

see above

getDescription

String getDescription()

Returns configuration description.

Returns:

configuration description.

getRunnerTypes

Collection<String> getRunnerTypes()

Returns collection of types of enabled build runners configured in this configuration

Returns:

see above

isPersonal

boolean isPersonal()

Returns if the configuration is temporary created for the personal build.

Returns:

true if configuration was created to run some personal changes. Such sort of configurations are not available from an administrative interface, only for internal usage.

getCheckoutType

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.

Returns:

method to get sources on agent.

isPaused

boolean isPaused()

Returns if the configuration is paused.

Returns:

true is build is paused. In this state build can be added to queue manually only, all other triggers are disabled.

getProjectId

@NotNull
String getProjectId()

Returns internal id of the project this build configuration configured in.

Returns:

parent project internal id.

getProjectExternalId

@NotNull
String getProjectExternalId()

Returns external id of the project this build configuration configured in.

Returns:

parent project external id.

Since:

8.0