jetbrains.buildServer
Interface BuildTypeDescriptor

All Superinterfaces:

java.lang.Comparable<BuildTypeDescriptor>

All Known Subinterfaces:

BuildType, RemoteBuildType, SBuildType

public interface BuildTypeDescriptor
extends java.lang.Comparable<BuildTypeDescriptor>

General build configuration data.

Nested Class Summary

static class

BuildTypeDescriptor.CheckoutType Possible modes of check out process.

Method Summary

java.lang.String	getBuildTypeId() Returns build configuration id.
BuildTypeDescriptor.CheckoutType	getCheckoutType() Returns method used by agent to retrieve project sources.
java.lang.String	getDescription() Returns configuration descrition.
java.lang.String	getFullName() Returns name in the form: <project name> :: <build type name>
java.lang.String	getName() Returns presentable name.
java.lang.String	getProjectId() Returns id of the project this build configuration configured in.
java.lang.String	getProjectName() Returns project name this configuration belongs to.
java.util.Collection<java.lang.String>	getRunnerTypes() Returns collection of types of enabled build runners configured in this configuration
java.lang.String	getRunType() Deprecated. since 6.0 returns type of the first runner only
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

Method Detail

getBuildTypeId

@NotNull
java.lang.String getBuildTypeId()

Returns build configuration id. Cannot be changed.

Returns:

unique id

getProjectName

@NotNull
java.lang.String getProjectName()

Returns project name this configuration belongs to.

Returns:

parent project name.

getName

java.lang.String getName()

Returns presentable name. Can be changed by the user.

Returns:

presentable name

getFullName

java.lang.String getFullName()

Returns name in the form: <project name> :: <build type name>

Returns:

see above

getDescription

java.lang.String getDescription()

Returns configuration descrition.

Returns:

configuration description.

getRunType

java.lang.String getRunType()

Deprecated. since 6.0 returns type of the first runner only

Returns build runner type this configuration is configured to be executed by.

Returns:

build runner type

getRunnerTypes

java.util.Collection<java.lang.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
java.lang.String getProjectId()

Returns id of the project this build configuration configured in.

Returns:

parent project id.