Package com.atlassian.bitbucket.codeinsights.annotation

Interface InsightAnnotation

public interface InsightAnnotation
Since:
5.15

  • Method Details

    • getExternalId

      @Nonnull Optional<String> getExternalId()
      If present, represents the id in the external system.
      Returns:
      the id, or empty if no value was supplied

    • getFilePath

      @Nonnull Optional<String> getFilePath()
      Path of the file against which the annotation is created.

      Note: If annotations were requested for a pull request, then this path will be the path of the file in the pull request, which may be different to the path of the file in the source branch.

      Returns:
      the file path, or empty if the annotation isn't associated with a specific file.
      Since:
      6.9

    • getLine

      int getLine()
      Line at which the annotation would be displayed.
      Returns:
      the line at which the annotation should be displayed, or 0 if annotation is for a file

    • getLink

      @Nonnull Optional<URI> getLink()
      Callback link. This link is typically a link back to the tool 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

    • getMessage

      @Nonnull String getMessage()
      Message for the annotation.
      Returns:
      message of the annotation

    • getReportKey

      @Nonnull String getReportKey()
      The report key of the report to which this annotation belongs
      Returns:
      the report key

    • getSeverity

      @Nonnull AnnotationSeverity getSeverity()
      The severity of the annotation.
      Returns:
      the severity

    • getType

      @Nonnull Optional<AnnotationType> getType()
      The type of an annotation.
      Returns:
      the type