Package jetbrains.buildServer.serverSide
Interface SBuildRunnerDescriptor
-
- All Superinterfaces:
BuildRunnerDescriptor
,ParametersDescriptor
- All Known Subinterfaces:
SRunnerContext
public interface SBuildRunnerDescriptor extends BuildRunnerDescriptor
Represents build runner settings in a build configuration, can be obtained from SBuildType. To create instance of this class useBuildRunnerDescriptorFactory
orBuildTypeSettings.addBuildRunner(String, String, java.util.Map)
.- Since:
- 6.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.String
getFullDisplayName()
Return full step name including the name specified by user + the runner type name afterwards.java.util.Collection<InvalidProperty>
getInvalidProperties()
RunType
getRunType()
Return object representing type of the build runnerjava.util.Collection<Requirement>
getRunTypeRequirements()
Returns additional agent requirements imposed by runner.RunTypeWithExtensions
getRunTypeWithExtensions()
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildRunnerDescriptor
getName, getOwnBuildParameters
-
Methods inherited from interface jetbrains.buildServer.serverSide.ParametersDescriptor
getId, getParameters, getType
-
-
-
-
Method Detail
-
getRunType
@NotNull RunType getRunType()
Return object representing type of the build runner- Returns:
- see above
-
getRunTypeWithExtensions
@NotNull RunTypeWithExtensions getRunTypeWithExtensions()
- Returns:
- object representing run type with extensions
-
getRunTypeRequirements
@NotNull java.util.Collection<Requirement> getRunTypeRequirements()
Returns additional agent requirements imposed by runner.- Returns:
- see above
-
getInvalidProperties
@NotNull java.util.Collection<InvalidProperty> getInvalidProperties()
- Returns:
- collection of invalid properties from extended run type properties processor
- Since:
- 8.0
- See Also:
RunTypeBase.getRunnerPropertiesProcessor()
-
getFullDisplayName
default java.lang.String getFullDisplayName()
Return full step name including the name specified by user + the runner type name afterwards. If user did not specify name, the name of the runner type returned.Thus, if the step named Foo, the returned value may be Foo (Command Line)
- Returns:
- see above
- Since:
- 2022.03
-
-