Class PublishChecksStep.StepChecksAnnotation

java.lang.Object
hudson.model.AbstractDescribableImpl<PublishChecksStep.StepChecksAnnotation>
io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
All Implemented Interfaces:
Describable<PublishChecksStep.StepChecksAnnotation>, Serializable
Enclosing class:
PublishChecksStep

public static class PublishChecksStep.StepChecksAnnotation extends AbstractDescribableImpl<PublishChecksStep.StepChecksAnnotation> implements Serializable
A simple wrapper for ChecksAnnotation to allow users add code annotations by PublishChecksStep.
See Also:
  • Constructor Details

    • StepChecksAnnotation

      @DataBoundConstructor public StepChecksAnnotation(String path, int startLine, int endLine, String message)
      Creates an annotation with required parameters.
      Parameters:
      path - path of the file to annotate
      startLine - start line of the annotation
      endLine - end line of the annotation
      message - annotation message
  • Method Details

    • setStartColumn

      @DataBoundSetter public void setStartColumn(Integer startColumn)
    • setEndColumn

      @DataBoundSetter public void setEndColumn(Integer endColumn)
    • setTitle

      @DataBoundSetter public void setTitle(String title)
    • setRawDetails

      @DataBoundSetter public void setRawDetails(String rawDetails)
    • setAnnotationLevel

      @DataBoundSetter public void setAnnotationLevel(ChecksAnnotation.ChecksAnnotationLevel annotationLevel)
    • getPath

      public String getPath()
    • getStartLine

      public int getStartLine()
    • getEndLine

      public int getEndLine()
    • getMessage

      public String getMessage()
    • getStartColumn

      @CheckForNull public Integer getStartColumn()
    • getEndColumn

      @CheckForNull public Integer getEndColumn()
    • getTitle

      @CheckForNull public String getTitle()
    • getRawDetails

      @CheckForNull public String getRawDetails()
    • getAnnotationLevel

      public ChecksAnnotation.ChecksAnnotationLevel getAnnotationLevel()
    • getAnnotation

      public ChecksAnnotation getAnnotation()
      Get ChecksAnnotation built with user-provided parameters in PublishChecksStep.
      Returns:
      the annotation built with provided parameters