public interface

InsightReportService

com.atlassian.bitbucket.codeinsights.report.InsightReportService

Summary

Public Methods
void delete(DeleteInsightReportRequest request)
Delete a single report.
@Nonnull Optional<InsightReport> get(GetInsightReportRequest request)
Retrieve a single report.
@Nonnull Page<InsightReport> search(SearchInsightReportRequest request, PageRequest pageRequest)
Retrieve a page of reports.
@Nonnull InsightReport set(SetInsightReportRequest request)
Create or update an insight report as described by the provided request.

Public Methods

public void delete (DeleteInsightReportRequest request)

Delete a single report.

Parameters
request request detailing the report to remove

@Nonnull public Optional<InsightReport> get (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

@Nonnull public Page<InsightReport> search (SearchInsightReportRequest request, 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

@Nonnull public InsightReport set (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
ArgumentValidationException if any of the arguments did not pass validation. Check the message for details of what went wrong.
AuthorisationException if the user doesn't have permission to access the repository or is not permitted to update a report