Package jetbrains.buildServer.serverSide.buildDistribution

Interface GenericAgentsFilterContext<T>

Type Parameters:

T -

All Known Subinterfaces:

AgentsFilterContext, VirtualAgentsFilterContext

All Known Implementing Classes:

DefaultAgentsFilterContext, VirtualAgentsFilterContextImpl

public interface GenericAgentsFilterContext<T>

Since:

2020.2.4

Method Summary

Modifier and Type	Method	Description
Collection<T>	getAgentsForStartingBuild()	Returns agents available for the starting build.
Object	getCustomData(String key)	Gets custom data, associated with specified key
Map<QueuedBuildInfo,SBuildAgent>	getDistributedBuilds()	Returns map of the queued builds already assigned to connected agents.
BuildDistributorInput	getDistributorInput()	Returns agent distributor input (running builds, queue, agents and so on).
QueuedBuildInfo	getStartingBuild()	The build which is going to start, i.e.
boolean	isEmulationMode()	Returns true if the filter is called in the emulation mode.
void	setCustomData(String key, Object data)	Sets data in the context under specified key

Method Detail

getStartingBuild

@NotNull
QueuedBuildInfo getStartingBuild()

The build which is going to start, i.e. the build for which the agents are being filtered.

Returns:

see above

getAgentsForStartingBuild

@NotNull
Collection<T> getAgentsForStartingBuild()

Returns agents available for the starting build.

Returns:

see above

getDistributedBuilds

@NotNull
Map<QueuedBuildInfo,SBuildAgent> getDistributedBuilds()

Returns map of the queued builds already assigned to connected agents. This map cannot be edited.

Returns:

see above

getDistributorInput

@NotNull
BuildDistributorInput getDistributorInput()

Returns agent distributor input (running builds, queue, agents and so on).

Returns:

see above

isEmulationMode

boolean isEmulationMode()

Returns true if the filter is called in the emulation mode. Emulation mode is used to compute estimates, not to start builds.

Returns:

see above

getCustomData

@Nullable
Object getCustomData(@NotNull
                     String key)

Gets custom data, associated with specified key

Parameters:

key - of the data

Returns:

object, stored under key, if there is one, null otherwise

Since:

8.0

setCustomData

void setCustomData(@NotNull
                   String key,
                   @Nullable
                   Object data)

Sets data in the context under specified key

Parameters:

key - key to store data

data - data to store

Since:

8.0 Providing null as data will erase existing one