Index (Checks API plugin 1.3.0 API)

A B C D F G I J N O P S T V W

A

AbstractStatusChecksProperties - Class in io.jenkins.plugins.checks.status: Extension points for implementations to provide status checks properties.
AbstractStatusChecksProperties() - Constructor for class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties
addAction(ChecksAction) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Adds a ChecksAction.
addAnnotation(ChecksAnnotation) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Adds a ChecksAnnotation.
addImage(ChecksImage) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Adds a ChecksImage.
addText(String) - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder: Adds a chunk of text to the builder.

B

build() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Actually builds the ChecksAnnotation.
build() - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Actually build the ChecksDetail.
build() - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Actually builds the ChecksOutput with given parameters.
build(int) - Method in class io.jenkins.plugins.checks.api.TruncatedString: Builds the string such that it does not exceed maxSize, including the truncation string.
build() - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder: Builds the TruncatedString.
Builder() - Constructor for class io.jenkins.plugins.checks.api.TruncatedString.Builder
BuildStatusChecksPublisher - Class in io.jenkins.plugins.checks.status: A publisher which publishes different statuses through the checks API based on the stage of the Queue.Item or Run.
BuildStatusChecksPublisher() - Constructor for class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher
BuildStatusChecksPublisher.JobCheckoutListener - Class in io.jenkins.plugins.checks.status
BuildStatusChecksPublisher.JobCompletedListener - Class in io.jenkins.plugins.checks.status
BuildStatusChecksPublisher.JobScheduledListener - Class in io.jenkins.plugins.checks.status

C

ChecksAction - Class in io.jenkins.plugins.checks.api: An action of a check.
ChecksAction(String, String, String) - Constructor for class io.jenkins.plugins.checks.api.ChecksAction: Creates a ChecksAction using the given parameters.
ChecksAnnotation - Class in io.jenkins.plugins.checks.api: An annotation for specific lines of code.
ChecksAnnotation(ChecksAnnotation) - Constructor for class io.jenkins.plugins.checks.api.ChecksAnnotation: Copy constructor.
ChecksAnnotation.ChecksAnnotationBuilder - Class in io.jenkins.plugins.checks.api: Builder for ChecksAnnotation.
ChecksAnnotation.ChecksAnnotationLevel - Enum in io.jenkins.plugins.checks.api: The level represents the severity of the annotation.
ChecksAnnotationBuilder() - Constructor for class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Constructs a builder for ChecksAnnotation.
ChecksConclusion - Enum in io.jenkins.plugins.checks.api: Conclusion for a specific check.
ChecksDetails - Class in io.jenkins.plugins.checks.api: Details of a check.
ChecksDetails.ChecksDetailsBuilder - Class in io.jenkins.plugins.checks.api: Builder for ChecksDetails.
ChecksDetailsBuilder() - Constructor for class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Construct a builder for ChecksDetails.
ChecksImage - Class in io.jenkins.plugins.checks.api: An image of a check.
ChecksImage(String, String, String) - Constructor for class io.jenkins.plugins.checks.api.ChecksImage: Constructs an image with all parameters.
ChecksInfo - Class in io.jenkins.plugins.checks.steps: A collection of checks properties that will be injected into WithChecksStep closure.
ChecksInfo(String) - Constructor for class io.jenkins.plugins.checks.steps.ChecksInfo: Creates a ChecksInfo with checks name.
ChecksOutput - Class in io.jenkins.plugins.checks.api: An output of a check.
ChecksOutput(ChecksOutput) - Constructor for class io.jenkins.plugins.checks.api.ChecksOutput: Copy constructor of the ChecksOutput.
ChecksOutput.ChecksOutputBuilder - Class in io.jenkins.plugins.checks.api: Builder for ChecksOutput.
ChecksOutputBuilder() - Constructor for class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Construct a builder for a ChecksOutput.
ChecksPublisher - Class in io.jenkins.plugins.checks.api: A general publisher for publishing checks to different platforms.
ChecksPublisher() - Constructor for class io.jenkins.plugins.checks.api.ChecksPublisher
ChecksPublisher.NullChecksPublisher - Class in io.jenkins.plugins.checks.api: A null publisher.
ChecksPublisherFactory - Class in io.jenkins.plugins.checks.api: A publisher API for consumers to publish checks.
ChecksPublisherFactory() - Constructor for class io.jenkins.plugins.checks.api.ChecksPublisherFactory
ChecksStatus - Enum in io.jenkins.plugins.checks.api: Status for a specific check.
createPublisher(Run<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory: Creates a ChecksPublisher according to the SCM used by the Run.
createPublisher(Job<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory: Creates a ChecksPublisher according to the SCM used by the Job.

D

doFillConclusionItems() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor: Fill the dropdown list model with all ChecksConclusions.
doFillStatusItems() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor: Fill the dropdown list model with all ChecksStatuses.

F

fromJob(Job<?, ?>, TaskListener) - Static method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory: Returns a suitable publisher for the job.
fromRun(Run<?, ?>, TaskListener) - Static method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory: Returns a suitable publisher for the run.

G

getActions() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the ChecksActions of a check.
getAlt() - Method in class io.jenkins.plugins.checks.api.ChecksImage: Returns the alternative text for the image.
getAnnotationLevel() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getCaption() - Method in class io.jenkins.plugins.checks.api.ChecksImage: Returns the short description of the image.
getChecksAnnotations() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
getChecksImages() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
getCompletedAt() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the time that the check completed.
getConclusion() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the conclusion of a check.
getConclusion() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getDescription() - Method in class io.jenkins.plugins.checks.api.ChecksAction
getDetailsURL() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the url of a site with full details of a check.
getDetailsURL() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getDisplayName() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
getDisplayName() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
getEndColumn() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getEndLine() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getFunctionName() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
getFunctionName() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
getIdentifier() - Method in class io.jenkins.plugins.checks.api.ChecksAction
getImageUrl() - Method in class io.jenkins.plugins.checks.api.ChecksImage: Returns the image URL.
getImageURL() - Method in class io.jenkins.plugins.checks.api.ChecksImage: Returns the image URL.
getLabel() - Method in class io.jenkins.plugins.checks.api.ChecksAction
getMessage() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getName() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the name of a check.
getName(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties: Returns the name of the status check.
getName(Job<?, ?>) - Method in interface io.jenkins.plugins.checks.status.StatusChecksProperties: Deprecated.

Returns the name of the status check.
getName() - Method in class io.jenkins.plugins.checks.steps.ChecksInfo
getName() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getName() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep
getOutput() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the ChecksOutput of a check.
getPath() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getRawDetails() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getRequiredContext() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
getRequiredContext() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
getStartColumn() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getStartedAt() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the time that the check started.
getStartLine() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getStatus() - Method in class io.jenkins.plugins.checks.api.ChecksDetails: Returns the status of a check.
getStatus() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getSummary() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
getSummary(int) - Method in class io.jenkins.plugins.checks.api.ChecksOutput: Get the output summary, truncated by TruncatedString to maxSize.
getSummary() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getText() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
getText(int) - Method in class io.jenkins.plugins.checks.api.ChecksOutput: Get the output text, truncated by TruncatedString to maxSize.
getText() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
getTitle() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
getTitle() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
getTitle() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep

I

io.jenkins.plugins.checks - package io.jenkins.plugins.checks: Provides default Findbugs annotations.
io.jenkins.plugins.checks.api - package io.jenkins.plugins.checks.api: Provides default Findbugs annotations.
io.jenkins.plugins.checks.status - package io.jenkins.plugins.checks.status: Provides default Findbugs annotations.
io.jenkins.plugins.checks.steps - package io.jenkins.plugins.checks.steps: Provides default Findbugs annotations.
isApplicable(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties: Returns whether the implementation is applicable for the job.
isApplicable(Job<?, ?>) - Method in interface io.jenkins.plugins.checks.status.StatusChecksProperties: Deprecated.

Returns if the implementation is applicable for the job.
isSkip(Job<?, ?>) - Method in interface io.jenkins.plugins.checks.status.StatusChecksProperties: Deprecated.

Returns if skip publishing status checks.
isSkipped(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties: Returns whether to skip publishing status checks.

J

JobCheckoutListener() - Constructor for class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobCheckoutListener
JobCompletedListener() - Constructor for class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobCompletedListener
JobScheduledListener() - Constructor for class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobScheduledListener

N

NullChecksPublisher(PluginLogger) - Constructor for class io.jenkins.plugins.checks.api.ChecksPublisher.NullChecksPublisher: Construct a null checks publisher with PluginLogger.

O

onCheckout(Run<?, ?>, SCM, FilePath, TaskListener, File, SCMRevisionState) - Method in class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobCheckoutListener
onCompleted(Run, TaskListener) - Method in class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobCompletedListener
onEnterWaiting(Queue.WaitingItem) - Method in class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.JobScheduledListener

P

publish(ChecksDetails) - Method in class io.jenkins.plugins.checks.api.ChecksPublisher.NullChecksPublisher
publish(ChecksDetails) - Method in class io.jenkins.plugins.checks.api.ChecksPublisher: Publishes checks to platforms.
PublishChecksStep - Class in io.jenkins.plugins.checks.steps: Pipeline step to publish customized checks.
PublishChecksStep() - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep: Constructor used for pipeline by Stapler.
PublishChecksStep.PublishChecksStepDescriptor - Class in io.jenkins.plugins.checks.steps: This step's descriptor which defines function name, display name, and context.
PublishChecksStepDescriptor() - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor

S

setChunkOnNewlines() - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder: Sets truncator to chunk on newlines rather than the chunks.
setConclusion(ChecksConclusion) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setDetailsURL(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setName(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setStatus(ChecksStatus) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setSummary(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setText(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setTitle(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
setTruncateStart() - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder: Sets truncator to remove excess text from the start, rather than the end.
start(StepContext) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
start(StepContext) - Method in class io.jenkins.plugins.checks.steps.WithChecksStep
StatusChecksProperties - Interface in io.jenkins.plugins.checks.status: Deprecated.
The interface is incompatible for future changes, use AbstractStatusChecksProperties instead

T

takesImplicitBlockArgument() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
toString() - Method in class io.jenkins.plugins.checks.api.ChecksAction
toString() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
toString() - Method in class io.jenkins.plugins.checks.api.ChecksDetails
toString() - Method in class io.jenkins.plugins.checks.api.ChecksImage
toString() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
toString() - Method in class io.jenkins.plugins.checks.api.TruncatedString: Builds the string without truncation.
TruncatedString - Class in io.jenkins.plugins.checks.api: Utility wrapper that silently truncates output with a message at a certain size.
TruncatedString.Builder - Class in io.jenkins.plugins.checks.api: Builder for TruncatedString.

V

valueOf(String) - Static method in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.jenkins.plugins.checks.api.ChecksConclusion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.jenkins.plugins.checks.api.ChecksStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.jenkins.plugins.checks.api.ChecksConclusion: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.jenkins.plugins.checks.api.ChecksStatus: Returns an array containing the constants of this enum type, in the order they are declared.

W

withActions(List<ChecksAction>) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the actions of a check.
withAnnotationLevel(ChecksAnnotation.ChecksAnnotationLevel) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets the annotation level, one of NOTICE, WARNING, or FAILURE.
withAnnotations(List<ChecksAnnotation>) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Sets the ChecksAnnotation for a check run.
WithChecksStep - Class in io.jenkins.plugins.checks.steps: Pipeline step that injects a ChecksInfo into the closure.
WithChecksStep(String) - Constructor for class io.jenkins.plugins.checks.steps.WithChecksStep: Creates the step with a name to inject.
WithChecksStep.WithChecksStepDescriptor - Class in io.jenkins.plugins.checks.steps: This step's descriptor which defines the function name ("withChecks") and required context.
WithChecksStepDescriptor() - Constructor for class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
withCompletedAt(LocalDateTime) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the time when a check completes.
withConclusion(ChecksConclusion) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the conclusion of a check.
withDetailsURL(String) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the url of a site with full details of a check.
withEndColumn(Integer) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Adds end column of the annotation.
withEndLine(Integer) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets the end line of annotation.
withImages(List<ChecksImage>) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Sets the ChecksImage for a check run.
withLine(int) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets the line of the single line annotation.
withMessage(String) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets a short description of the feedback for the annotation.
withName(String) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the name of the check.
withOutput(ChecksOutput) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the output of a check.
withPath(String) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets the path of the file to annotate.
withRawDetails(String) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Adds the details about this annotation.
withStartColumn(Integer) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Adds start column of the annotation.
withStartedAt(LocalDateTime) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the time when a check starts.
withStartLine(Integer) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Sets the start line of annotation.
withStatus(ChecksStatus) - Method in class io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder: Set the status of the check.
withSummary(String) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Sets the summary of the check run
withSummary(TruncatedString) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Sets the summary of the check run, using a TruncatedString.
withText(String) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Adds the details description for a check run.
withText(TruncatedString) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Adds the details description for a check run, using a TruncatedString.
withTitle(String) - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder: Adds the title that represents the annotation.
withTitle(String) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder: Sets the title of the check run.
withTruncationText(String) - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder: Sets the truncation text.

A B C D F G I J N O P S T V W