Package jetbrains.buildServer.serverSide
Interface TriggeredBy
-
public interface TriggeredBy
Contains detailed information about who added build in queue and with what parameters.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAsString()
Returns text to show in the UIjava.lang.String
getAsString(Filter<java.lang.String> paramNameFilter)
Returns text to show in the UIjava.util.Map<java.lang.String,java.lang.String>
getParameters()
Returns additional parameters specified when build was triggered.java.lang.String
getRawTriggeredBy()
Returns raw (unparsed) triggered by fieldjava.util.Date
getTriggeredDate()
Returns date when build was triggered.java.lang.String
getTriggerId()
returns trigger id which triggered the build.SUser
getUser()
Returns user who triggered this build.boolean
isTriggeredBySnapshotDependency()
Determins if the build was triggered as a snapshot dependency.boolean
isTriggeredByUser()
Returns true if build was triggered by user directly or indirectly (i.e.
-
-
-
Method Detail
-
getAsString
@NotNull java.lang.String getAsString()
Returns text to show in the UI- Returns:
- text to show in the UI
-
getAsString
@NotNull java.lang.String getAsString(@NotNull Filter<java.lang.String> paramNameFilter)
Returns text to show in the UI- Parameters:
paramNameFilter
- filter for including into string presentation only needed information- Returns:
- text to show in the UI
- Since:
- 6.5.2
-
getRawTriggeredBy
java.lang.String getRawTriggeredBy()
Returns raw (unparsed) triggered by field- Returns:
- see above
-
getUser
@Nullable SUser getUser()
Returns user who triggered this build. If build was not triggered by user returns null. Can also return null if user who triggered build was deleted.- Returns:
- user who triggered build or null.
-
isTriggeredByUser
boolean isTriggeredByUser()
Returns true if build was triggered by user directly or indirectly (i.e. user triggered a build which snapshot-depends on this one)- Returns:
- see above
-
getTriggeredDate
@NotNull java.util.Date getTriggeredDate()
Returns date when build was triggered.- Returns:
- date when build was triggered.
-
getParameters
@NotNull java.util.Map<java.lang.String,java.lang.String> getParameters()
Returns additional parameters specified when build was triggered.- Returns:
- see above
-
getTriggerId
@Nullable java.lang.String getTriggerId()
returns trigger id which triggered the build. Result can be null if build was triggered not by trigger or trigger didn't provide its id on adding the build into the queue or for builds, triggered before 2021.1- Since:
- 2021.1
-
isTriggeredBySnapshotDependency
boolean isTriggeredBySnapshotDependency()
Determins if the build was triggered as a snapshot dependency.- Returns:
- true if build was triggered as a snapshot dependency
- Since:
- 2023.11
-
-