Package jetbrains.buildServer.virtualConfiguration.processor

Interface ProcessVirtualConfigurations

All Superinterfaces:

TeamCityExtension

All Known Implementing Classes:

GeneratePromotionsFromPipelineVirtualProcessor

public interface ProcessVirtualConfigurations
extends TeamCityExtension

Field Summary

Fields

Modifier and Type	Field	Description
static String	MAX_GENERATED_BUILDS_FOR_EACH_CHAIN
static String	TC_VIRTUAL_CONFIGURATION_PROCESSED_LIMIT_ERROR
static String	VIRTUAL_CONFIGURATION_RETENTION_MINUTES

Method Summary

Modifier and Type	Method	Description
List<BuildPromotion>	addToQueue(BuildPromotion promotion)
default List<BuildPromotion>	freeze(BuildPromotion promotion)	Called during the build promotion settings freeze.
default List<BuildPromotion>	freeze(BuildPromotion promotion, int maxNumberOfGeneratedBuilds)	Called during the build promotion settings freeze.
String	getType()
default boolean	supportsGeneratedBuildsLimit()

Field Detail

MAX_GENERATED_BUILDS_FOR_EACH_CHAIN

@NonNls
static final String MAX_GENERATED_BUILDS_FOR_EACH_CHAIN

See Also:

Constant Field Values

TC_VIRTUAL_CONFIGURATION_PROCESSED_LIMIT_ERROR

@NonNls
static final String TC_VIRTUAL_CONFIGURATION_PROCESSED_LIMIT_ERROR

See Also:

Constant Field Values

VIRTUAL_CONFIGURATION_RETENTION_MINUTES

@NonNls
static final String VIRTUAL_CONFIGURATION_RETENTION_MINUTES

See Also:

Constant Field Values

Method Detail

addToQueue

@NotNull
List<BuildPromotion> addToQueue(@NotNull
                                BuildPromotion promotion)

Parameters:

promotion - top promotion

Returns:

created new promotions from virtual configurations

freeze

@NotNull
default List<BuildPromotion> freeze(@NotNull
                                    BuildPromotion promotion,
                                    int maxNumberOfGeneratedBuilds)

Called during the build promotion settings freeze. At this point the extension can generate a new set of build promotions and add them to the queue. The generated build promotions should be returned as a result of this method. Note: this method is called only if extension supports a limit for the number of generated builds, i.e. when supportsGeneratedBuildsLimit() returns true

Parameters:

promotion - a build promotion to process

maxNumberOfGeneratedBuilds - current maximum limit for the generated build promotions

Returns:

all generated build promotions

freeze

@NotNull
default List<BuildPromotion> freeze(@NotNull
                                    BuildPromotion promotion)

Called during the build promotion settings freeze. At this point the extension can generate a new set of build promotions and add them to the queue. The generated build promotions should be returned as a result of this method. Note: this method is called instead of freeze(BuildPromotion, int) if extension does not support a limit for the number of generated builds, i.e. when supportsGeneratedBuildsLimit() returns false

Parameters:

promotion - a build promotion to process

Returns:

all generated build promotions

supportsGeneratedBuildsLimit

default boolean supportsGeneratedBuildsLimit()

Returns:

true if the extension implementation supports limit for the number of generated builds.

getType

@NotNull
String getType()