Package com.atlassian.bitbucket.codeinsights.report

Interface InsightReportService

public interface InsightReportService
Since:
5.15

  • Method Details

    • delete

      void delete(@Nonnull DeleteInsightReportRequest request)
      Delete a single report.
      Parameters:
      request - request detailing the report to remove

    • get

      @Nonnull Optional<InsightReport> get(@Nonnull GetInsightReportRequest request)
      Retrieve a single report.
      Parameters:
      request - request that details which report to retrieve
      Returns:
      the report if it can be found or an empty optional if the report does not (yet) exist

    • search

      @Nonnull com.atlassian.bitbucket.util.Page<InsightReport> search(@Nonnull SearchInsightReportRequest request, @Nonnull com.atlassian.bitbucket.util.PageRequest pageRequest)
      Retrieve a page of reports. Returns zero or more reports that match the criteria in the request.
      Parameters:
      request - request that details what reports to retrieve
      pageRequest - a request describing the page to retrieve
      Returns:
      a (possibly empty) page containing reports matching the request

    • set

      @Nonnull InsightReport set(@Nonnull SetInsightReportRequest request)
      Create or update an insight report as described by the provided request. If a report with the key and commit id already exists it will be overwritten.
      Parameters:
      request - the request describing the insight report to create or update
      Returns:
      the newly created or updated insight report
      Throws:
      com.atlassian.bitbucket.validation.ArgumentValidationException - if any of the arguments did not pass validation. Check the message for details of what went wrong.
      com.atlassian.bitbucket.AuthorisationException - if the user doesn't have permission to access the repository or is not permitted to update a report