Package com.atlassian.bitbucket.codeinsights.report

Class SetInsightReportRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder

com.atlassian.bitbucket.codeinsights.report.SetInsightReportRequest.Builder

Enclosing class:

SetInsightReportRequest

public static final class SetInsightReportRequest.Builder
extends AbstractInsightsBuilder

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor	Description
Builder(com.atlassian.bitbucket.repository.Repository repository, String commitId, String key, String title)	Create a builder with all the required fields.

Method Summary

Modifier and Type	Method	Description
SetInsightReportRequest	build()
SetInsightReportRequest.Builder	coverageProviderKey(String value)	A key representing the coverage provider.
SetInsightReportRequest.Builder	data(InsightReportData value)
SetInsightReportRequest.Builder	data(List<InsightReportData> values)
SetInsightReportRequest.Builder	details(String value)	Some text to display on the insight report.
SetInsightReportRequest.Builder	link(URI value)	The URL to the product's page that contains the original insight data
SetInsightReportRequest.Builder	logoUrl(URI value)	Logo to display on the report.
SetInsightReportRequest.Builder	reporter(String value)	The reporter of the tool that created the report.
SetInsightReportRequest.Builder	result(InsightResult value)	Result of the report.

Methods inherited from class com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder

validate

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(@Nonnull
 com.atlassian.bitbucket.repository.Repository repository,
 @Nonnull
 String commitId,
 @Nonnull
 String key,
 @Nonnull
 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

Method Details

build

@Nonnull
public SetInsightReportRequest build()

coverageProviderKey

@Nonnull
public SetInsightReportRequest.Builder coverageProviderKey(@Nullable
 String value)

A key representing the coverage provider.

Parameters:

value - if present must be shorter than 2000 chars

Returns:

the builder

Since:

6.8

data

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

data

@Nonnull
public SetInsightReportRequest.Builder data(@Nonnull
 InsightReportData value)

details

@Nonnull
public SetInsightReportRequest.Builder details(@Nullable
 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

link

@Nonnull
public SetInsightReportRequest.Builder link(@Nullable
 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

logoUrl

@Nonnull
public SetInsightReportRequest.Builder logoUrl(@Nullable
 URI value)

Logo to display on the report.

Parameters:

value - the reporter's logo to display on the insight report

Returns:

the builder

result

@Nonnull
public SetInsightReportRequest.Builder result(@Nullable
 InsightResult value)

Result of the report.

Parameters:

value - the result of the report

Returns:

the builder

reporter

@Nonnull
public SetInsightReportRequest.Builder reporter(@Nullable
 String value)

The reporter of the tool that created the report.

Parameters:

value - if present, must be under 450 characters long

Returns:

the builder