Package io.jenkins.blueocean.rest.model

Interface BlueItemRun

  • All Known Implementing Classes:
    BlueRun
    public interface BlueItemRun
    Common interface for job run details

    • Method Detail

      • getOrganization

        @Exported(name="organization")
String getOrganization()
        Returns:
        name of the organization

      • getId

        @Exported(name="id")
String getId()
        Returns:
        BlueRun id - unique within a pipeline

      • getPipeline

        @Exported(name="pipeline")
String getPipeline()
        Returns:
        Pipeline name - unique within an organization

      • getName

        @Exported(name="name")
String getName()

      • getDescription

        @Exported(name="description")
String getDescription()

      • getStartTimeString

        @Exported(name="startTime")
String getStartTimeString()
        Returns:
        run start time

      • getEnQueueTimeString

        @Exported(name="enQueueTime")
String getEnQueueTimeString()
        Enque time

      • getEndTimeString

        @Exported(name="endTime")
String getEndTimeString()
        Run end time

      • getDurationInMillis

        @Exported(name="durationInMillis")
Long getDurationInMillis()
        Returns:
        Build duration in milli seconds

      • getEstimatedDurtionInMillis

        @Exported(name="estimatedDurationInMillis")
Long getEstimatedDurtionInMillis()
        Returns:
        Estimated Build duration in milli seconds

      • getStateObj

        @Exported(name="state")
BlueRun.BlueRunState getStateObj()
        Returns:
        The state of the run

      • getResult

        @Exported(name="result")
BlueRun.BlueRunResult getResult()
        Returns:
        The result state of the job (e.g unstable)

      • getRunSummary

        @Exported(name="runSummary")
String getRunSummary()
        Returns:
        Build summary

      • getType

        @Exported(name="type")
String getType()
        Returns:
        Type of Run. Type name to be Jenkins Run.getClass().getSimpleName()

      • getArtifactsZipFile

        @Exported
String getArtifactsZipFile()
        Returns:
        Uri of artifacts zip file.

      • getActions

        @Navigable
@Exported(name="actions",
          inline=true)
Collection<BlueActionProxy> getActions()
        Returns:
        Gives Actions associated with this Run, if requested via tree

      • getTestSummary

        @Exported(name="testSummary",
          inline=true,
          skipNull=true)
BlueTestSummary getTestSummary()
        Returns:
        Gives the test summary for this run

      • getLog

        @Navigable
Object getLog()
        Returns:
        Instance of stapler aware instance that can do the following:

        • Must be able to process start query parameter. 'start' parameter is the byte offset in the actual log file
        • Must produce following HTTP headers in the response
        • X-Text-Size It is the byte offset of the raw log file client should use in the next request as value of start query parameter.
        • X-More-Data If its true, then client should repeat the request after some delay. In the repeated request it should use X-TEXT-SIZE header value with *start* query parameter.

      • getCauseOfBlockage

        @Exported(name="causeOfBlockage")
String getCauseOfBlockage()
        Returns:
        cause of what is blocking this run

      • isReplayable

        @Exported(name="replayable")
boolean isReplayable()
        Returns:
        if the run will allow a replay