public static final class

SetInsightReportRequest.Builder

extends AbstractInsightsBuilder
java.lang.Object
   ↳ com.atlassian.bitbucket.util.BuilderSupport
     ↳ com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder
       ↳ com.atlassian.bitbucket.codeinsights.report.SetInsightReportRequest.Builder

Summary

[Expand]
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Public Constructors
Builder(Repository repository, String commitId, String key, String title)
Create a builder with all the required fields.
Public Methods
@Nonnull SetInsightReportRequest build()
@Nonnull SetInsightReportRequest.Builder data(InsightReportData value)
@Nonnull SetInsightReportRequest.Builder data(List<InsightReportData> values)
@Nonnull SetInsightReportRequest.Builder details(String value)
Some text to display on the insight report.
@Nonnull SetInsightReportRequest.Builder link(URI value)
The URL to the product's page that contains the original insight data
@Nonnull SetInsightReportRequest.Builder logoUrl(URI value)
Logo to display on the report.
@Nonnull SetInsightReportRequest.Builder reporter(String value)
The reporter for of the tool that created the report.
@Nonnull SetInsightReportRequest.Builder result(InsightResult value)
Result of the report.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Public Constructors

public Builder (Repository repository, String commitId, String key, String title)

Create a builder with all the required fields.

Parameters
repository repository that the report belongs to
commitId the hash for the commit to associate with this report
key the key for the report to create. Cannot be blank and must be under 450 characters long
title the title for the report to create. Cannot be blank and must be under 450 characters long
Throws
IllegalArgumentException if any value does not pass validation. See message for details

Public Methods

@Nonnull public SetInsightReportRequest build ()

@Nonnull public SetInsightReportRequest.Builder data (InsightReportData value)

@Nonnull public SetInsightReportRequest.Builder data (List<InsightReportData> values)

@Nonnull public SetInsightReportRequest.Builder details (String value)

Some text to display on the insight report. A longer text field providing more details about the report.

Parameters
value if present must be shorter than 2000 chars
Returns
  • the builder

@Nonnull public SetInsightReportRequest.Builder link (URI value)

The URL to the product's page that contains the original insight data

Parameters
value link to the reporting tool
Returns
  • the builder

@Nonnull public SetInsightReportRequest.Builder logoUrl (URI value)

Logo to display on the report.

Parameters
value the reporter's logo to display on the insight report
Returns
  • the builder

@Nonnull public SetInsightReportRequest.Builder reporter (String value)

The reporter for of the tool that created the report.

Parameters
value if present, must be under 450 characters long
Returns
  • the builder

@Nonnull public SetInsightReportRequest.Builder result (InsightResult value)

Result of the report.

Parameters
value the result of the report
Returns
  • the builder