Package com.atlassian.bitbucket.codeinsights.report

Interface InsightReport

public interface InsightReport
Represents an InsightReport.
Since:
5.15

  • Method Details

    • getCommitId

      @Nonnull String getCommitId()
      The commit id which this report was registered against.
      Returns:
      the commit id

    • getCoverageProviderKey

      @Nonnull Optional<String> getCoverageProviderKey()
      Returns:
      an Optional containing the code coverage provider key, or Optional.empty() if no provider
      Since:
      6.8

    • getCreatedDate

      @Nonnull Date getCreatedDate()
      The date this report was created.
      Returns:
      The date this report was created, the date would be the date of the node servicing the request to create the report

    • getData

      @Nonnull List<InsightReportData> getData()
      Free form data stored with this report. The data is defined by the caller, and as such no guarantees are made on the shape of it. The order of the array is the same as it was when the report was stored.
      Returns:
      the data, if no data is stored an empty list will be returned

    • getDetails

      @Nonnull Optional<String> getDetails()
      Details for the report. This is typically a longer description of the report or longer information for the report. If the string is too long it will be either trimmed or truncated at the time of display.
      Returns:
      an Optional containing the stored details, or Optional.empty() if no details were recorded

    • getKey

      @Nonnull String getKey()
      Unique key for the report. This report is typically a reporter prefixed string and say a CI system plan key. The key should typically not contain the build number as that would generate multiple reports for the same commit if the build is re-run. There can only be one report with a given key for a commit.
      Returns:
      key for the report

    • getLink

      @Nonnull Optional<URI> getLink()
      Callback link. This link is typically a link back to the reporter that produced the report. For the case of CI system it would link back to the build that produced the report.
      Returns:
      an Optional containing the link, or Optional.empty() if no link was stored

    • getLogoUrl

      @Nonnull Optional<URI> getLogoUrl()
      URL to fetch the icon for the report from.
      Returns:
      an Optional containing the url or Optional.empty() if no icon is to be displayed

    • getRepository

      @Nonnull com.atlassian.bitbucket.repository.Repository getRepository()
      Repository that the report is attached to.
      Returns:
      the repository for this report

    • getResult

      @Nonnull Optional<InsightResult> getResult()
      The result of the report and by extension the job that produced the report. The semantic meaning of what a 'FAILED' report means is up to the producer of the report.
      Returns:
      an Optional containing the result or Optional.empty() if the report does not have a result

    • getTitle

      @Nonnull String getTitle()
      Title of the report.
      Returns:
      title of the report, this may contain characters that are unsafe to display without escaping

    • getReporter

      @Nonnull Optional<String> getReporter()
      Name of the tool that produced the report, this may contain characters that are unsafe to display without escaping.
      Returns:
      an Optional containing the reporter name or Optional.empty() if the report has no reporter