Package org.sonar.api.batch.sensor.issue
Interface NewExternalIssue
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description NewExternalIssue
addFlow(java.lang.Iterable<NewIssueLocation> flowLocations)
Register a flow for this issue.NewExternalIssue
addLocation(NewIssueLocation secondaryLocation)
Add a secondary location for this issue.NewExternalIssue
at(NewIssueLocation primaryLocation)
Primary location for this issue.NewExternalIssue
engineId(java.lang.String engineId)
Unique identifier of the external analyzer (e.g.NewExternalIssue
forRule(RuleKey ruleKey)
Deprecated.since 7.4.NewIssueLocation
newLocation()
Create a new location for this issue.NewExternalIssue
remediationEffortMinutes(java.lang.Long effortInMinutes)
Effort to fix the issue, in minutes.NewExternalIssue
ruleId(java.lang.String ruleId)
Unique rule identifier for a givenengineId(String)
void
save()
Save the issue.NewExternalIssue
severity(Severity severity)
Set the severity of the issue.NewExternalIssue
type(RuleType type)
Type of issue.
-
-
-
Method Detail
-
forRule
@Deprecated NewExternalIssue forRule(RuleKey ruleKey)
Deprecated.since 7.4. It is misleading, because of the "external_" prefix that is added on server side. UseengineId(String)
andruleId(String)
TheRuleKey
of the issue.
-
engineId
NewExternalIssue engineId(java.lang.String engineId)
Unique identifier of the external analyzer (e.g. eslint, pmd, ...)- Since:
- 7.4
-
ruleId
NewExternalIssue ruleId(java.lang.String ruleId)
Unique rule identifier for a givenengineId(String)
- Since:
- 7.4
-
type
NewExternalIssue type(RuleType type)
Type of issue.
-
remediationEffortMinutes
NewExternalIssue remediationEffortMinutes(@Nullable java.lang.Long effortInMinutes)
Effort to fix the issue, in minutes.
-
severity
NewExternalIssue severity(Severity severity)
Set the severity of the issue.
-
at
NewExternalIssue at(NewIssueLocation primaryLocation)
Primary location for this issue.
-
addLocation
NewExternalIssue addLocation(NewIssueLocation secondaryLocation)
Add a secondary location for this issue. Several secondary locations can be registered.
-
addFlow
NewExternalIssue addFlow(java.lang.Iterable<NewIssueLocation> flowLocations)
Register a flow for this issue. A flow is an ordered list of issue locations that help to understand the issue. It should be a path that backtracks the issue from its primary location to the start of the flow. Several flows can be registered.
-
newLocation
NewIssueLocation newLocation()
Create a new location for this issue. First registered location is considered as primary location.
-
save
void save()
Save the issue. If rule key is unknown or rule not enabled in the current quality profile then a warning is logged but no exception is thrown.
-
-