com.atlassian.bitbucket.codeinsights.annotation.InsightAnnotationService |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add annotations to a report.
| |||||||||||
Delete all annotations that match the provided request.
| |||||||||||
Get the annotation with a given externalId on the provided report
| |||||||||||
Update the existing annotation by replacing it with the data contained in the annotation request, or create it
if it doesn't exist.
| |||||||||||
Stream the annotations for a commit or a pull request.
|
Add annotations to a report.
request | request that details what annotations to create. If one of the annotations fail validation the entire batch is rejected. |
---|
ArgumentValidationException | if any of the annotations contains invalid data |
---|---|
AnnotationsLimitExceededException | if the total number of annotations (stored + new) would exceed the maximum allowed |
Delete all annotations that match the provided request. If no
externalIds
are provided all annotations
matching the provided reportKey
will be deleted.
request | a request describing the annotations to delete |
---|
Get the annotation with a given externalId on the provided report
report | The report to which this annotation belongs |
---|---|
externalId | The externalID to identify the annotation |
InsightAnnotation
, or empty()
if none exists
Update the existing annotation by replacing it with the data contained in the annotation request, or create it if it doesn't exist.
request | request that details the annotation to update and the new data |
---|
Stream the annotations for a commit or a pull request. Annotations will continue to be streamed until the
callback
returns false
or there are no
more annotations to stream.
request | a request describing the annotations to stream |
---|---|
callback | the callback onto which the annotations should be streamed |