Package io.jenkins.blueocean.rest.model

Class BlueChangeSetEntry

java.lang.Object
io.jenkins.blueocean.rest.model.Resource
io.jenkins.blueocean.rest.model.BlueChangeSetEntry
All Implemented Interfaces:
Reachable
public abstract class BlueChangeSetEntry extends Resource
Represents a single commit as a REST resource.
Author:
Ivan Meredith

  • Field Details

  • Constructor Details

    • BlueChangeSetEntry

      public BlueChangeSetEntry()

  • Method Details

    • getCommitId

      @Nullable @Exported(name="commitId") public abstract String getCommitId()
      Returns a human readable display name of the commit number, revision number, and such thing that identifies this entry.
      Returns:
      null if such a concept doesn't make sense for the implementation. For example, in CVS there's no single identifier for commits. Each file gets a different revision number.

    • getAuthor

      @NonNull @Exported(name="author", inline=true) public abstract BlueUser getAuthor()
      The user who made this change.
      Returns:
      never null.

    • getTimestamp

      @Nullable @Exported(name="timestamp") public abstract String getTimestamp()
      Returns the timestamp of this commit.
      Returns:
      null if the implementation doesn't support it (for example, in CVS a commit spreads over time between multiple changes on multiple files, so there's no single timestamp.)

    • getMsg

      @NonNull @Exported(name="msg") public abstract String getMsg()
      Gets the "commit message".
      Returns:
      Can be empty but never null.

    • getAffectedPaths

      @NonNull @Exported(name="affectedPaths") public abstract Collection<String> getAffectedPaths()
      Returns a set of paths in the workspace that was affected by this change.

      Contains string like 'foo/bar/zot'. No leading/trailing '/', and separator must be normalized to '/'.

      Returns:
      never null.

    • getUrl

      @Nullable @Exported(name="url") public abstract String getUrl()
      Returns a browser friendly url to the commit. E.g to github, or bitbucket.
      Returns:
      null if no applicable website exists

    • getIssues

      @Exported(name="issues", skipNull=true, inline=true) public abstract Collection<BlueIssue> getIssues()
      Returns:
      issue

    • getCheckoutCount

      @Exported(name="checkoutCount") public abstract Integer getCheckoutCount()

    • setCheckoutCount

      public abstract BlueChangeSetEntry setCheckoutCount(int checkoutCount)