Index
All Classes and Interfaces|All Packages|Serialized Form
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
- ACTION_REQUIRED - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- 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.
- asListBoxModel(Enum<?>...) - Method in class io.jenkins.plugins.checks.steps.StepUtils
-
Converts an
Enum
into aListBoxModel
with all values of it.
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() - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder
-
Builds the
TruncatedString
. - build(int) - Method in class io.jenkins.plugins.checks.api.TruncatedString
-
Deprecated.
- buildByBytes(int) - Method in class io.jenkins.plugins.checks.api.TruncatedString
-
Builds the string such that it does not exceed maxSize in bytes, including the truncation string.
- buildByChars(int) - Method in class io.jenkins.plugins.checks.api.TruncatedString
-
Builds the string such that it does not exceed maxSize in chars, including the truncation string.
- 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
orRun
. - BuildStatusChecksPublisher.ChecksGraphListener - Class in io.jenkins.plugins.checks.status
-
As a job progresses, record a representation of the flow graph.
- BuildStatusChecksPublisher.JobCheckoutListener - Class in io.jenkins.plugins.checks.status
-
Listens to the SCM checkout and publishes checks.
- BuildStatusChecksPublisher.JobCompletedListener - Class in io.jenkins.plugins.checks.status
-
Listens to the run and publishes checks.
- BuildStatusChecksPublisher.JobScheduledListener - Class in io.jenkins.plugins.checks.status
-
Listens to the queue and publishes checks in "queued" state for entering items.
C
- CANCELED - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- 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
. - ChecksGraphListener() - Constructor for class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.ChecksGraphListener
- 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.
- COMPLETED - Enum constant in enum io.jenkins.plugins.checks.api.ChecksStatus
- createPublisher(Job<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory
- createPublisher(Run<?, ?>, TaskListener) - Method in class io.jenkins.plugins.checks.api.ChecksPublisherFactory
D
- doFillAnnotationLevelItems() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation.StepChecksAnnotationDescriptor
-
Fill the dropdown list model with all
ChecksAnnotation.ChecksAnnotationLevel
values. - doFillConclusionItems() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
-
Fill the dropdown list model with all
ChecksConclusion
s. - doFillStatusItems() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
-
Fill the dropdown list model with all
ChecksStatus
es.
F
- FAILURE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel
- FAILURE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- FlowNodeUtils - Class in io.jenkins.plugins.checks.utils
-
Utility methods for working with FlowNodes.
- 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
- getAction() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
- getActions() - Method in class io.jenkins.plugins.checks.api.ChecksDetails
-
Returns the
ChecksAction
s of a check. - getActions() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- getAlt() - Method in class io.jenkins.plugins.checks.api.ChecksImage
-
Returns the alternative text for the image.
- getAnnotation() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
-
Get
ChecksAnnotation
built with user-provided parameters inPublishChecksStep
. - getAnnotationLevel() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
- getAnnotationLevel() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- getAnnotations() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- 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
- getDescription() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
- 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
- getEnclosingBlockNames(List<FlowNode>) - Static method in class io.jenkins.plugins.checks.utils.FlowNodeUtils
-
Get the stage and parallel branch names for these nodes, innermost first.
- getEnclosingStagesAndParallels(FlowNode) - Static method in class io.jenkins.plugins.checks.utils.FlowNodeUtils
-
Get the stage and parallel branch start node IDs (not the body nodes) for this node, innermost first.
- getEndColumn() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
- getEndColumn() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- getEndLine() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
- getEndLine() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- 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
- getIdentifier() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
- 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
- getLabel() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
- getMessage() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
- getMessage() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- getName() - Method in class io.jenkins.plugins.checks.api.ChecksDetails
-
Returns the name of a 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
- 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.
- 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
- getPath() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- getRawDetails() - Method in class io.jenkins.plugins.checks.api.ChecksAnnotation
- getRawDetails() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- 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
- getStartColumn() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- 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
- getStartLine() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- 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() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- getSummary(int) - Method in class io.jenkins.plugins.checks.api.ChecksOutput
-
Get the output summary, truncated by
TruncatedString
to maxSize. - getText() - Method in class io.jenkins.plugins.checks.api.ChecksOutput
- getText() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- getText(int) - Method in class io.jenkins.plugins.checks.api.ChecksOutput
-
Get the output text, truncated by
TruncatedString
to maxSize. - 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
- getTitle() - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
I
- IN_PROGRESS - Enum constant in enum io.jenkins.plugins.checks.api.ChecksStatus
- 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.
- io.jenkins.plugins.checks.utils - package io.jenkins.plugins.checks.utils
- 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
. - isIncludeStage() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep
- 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.
- isSkipProgressUpdates(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties
-
Returns whether to suppress progress updates from the
FlowExecutionAnalyzer
. - isSuppressLogs(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties
-
Returns whether to suppress log output in the
FlowExecutionAnalyzer
. - isUnstableBuildNeutral(Job<?, ?>) - Method in class io.jenkins.plugins.checks.status.AbstractStatusChecksProperties
-
Whether to conclude an unstable build as
ChecksConclusion.NEUTRAL
, else it would be concluded asChecksConclusion.FAILURE
; the default is false.
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
- NEUTRAL - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- NONE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel
- NONE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- NONE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksStatus
- NOTICE - Enum constant in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel
- 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
- onNewHead(FlowNode) - Method in class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.ChecksGraphListener
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.
- PublishChecksStep.StepChecksAction - Class in io.jenkins.plugins.checks.steps
-
A simple wrapper for
ChecksAction
to allow users add checks actions byPublishChecksStep
. - PublishChecksStep.StepChecksAction.StepChecksActionDescriptor - Class in io.jenkins.plugins.checks.steps
-
Descriptor for
PublishChecksStep.StepChecksAction
, required for Pipeline Snippet Generator. - PublishChecksStep.StepChecksAnnotation - Class in io.jenkins.plugins.checks.steps
-
A simple wrapper for
ChecksAnnotation
to allow users add code annotations byPublishChecksStep
. - PublishChecksStep.StepChecksAnnotation.StepChecksAnnotationDescriptor - Class in io.jenkins.plugins.checks.steps
-
Descriptor for
PublishChecksStep.StepChecksAnnotation
, required for Pipeline Snippet Generator. - PublishChecksStepDescriptor() - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.PublishChecksStepDescriptor
Q
- QUEUED - Enum constant in enum io.jenkins.plugins.checks.api.ChecksStatus
S
- setActions(List<PublishChecksStep.StepChecksAction>) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- setAnnotationLevel(ChecksAnnotation.ChecksAnnotationLevel) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- setAnnotations(List<PublishChecksStep.StepChecksAnnotation>) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- 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
- setDescription(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
- setDetailsURL(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- setEndColumn(Integer) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- setIncludeStage(boolean) - Method in class io.jenkins.plugins.checks.steps.WithChecksStep
- setName(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
- setRawDetails(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- setStartColumn(Integer) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- setStatus(ChecksStatus) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep
-
Change the status of the check.
- 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
- setTitle(String) - Method in class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
- setTruncateStart() - Method in class io.jenkins.plugins.checks.api.TruncatedString.Builder
-
Sets truncator to remove excess text from the start, rather than the end.
- SKIPPED - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- 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 - StepChecksAction(String, String) - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction
-
Creates an instance that wraps a newly constructed
ChecksAction
with according parameters. - StepChecksActionDescriptor() - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAction.StepChecksActionDescriptor
- StepChecksAnnotation(String, int, int, String) - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation
-
Creates an annotation with required parameters.
- StepChecksAnnotationDescriptor() - Constructor for class io.jenkins.plugins.checks.steps.PublishChecksStep.StepChecksAnnotation.StepChecksAnnotationDescriptor
- StepUtils - Class in io.jenkins.plugins.checks.steps
-
Utilities for pipeline steps.
- StepUtils() - Constructor for class io.jenkins.plugins.checks.steps.StepUtils
- SUCCESS - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
T
- takesImplicitBlockArgument() - Method in class io.jenkins.plugins.checks.steps.WithChecksStep.WithChecksStepDescriptor
- TIME_OUT - Enum constant in enum io.jenkins.plugins.checks.api.ChecksConclusion
- 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
- WARNING - Enum constant in enum io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel
- 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
, orFAILURE
. - 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(TruncatedString) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder
-
Sets the summary of the check run, using a
TruncatedString
. - withSummary(String) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder
-
Sets the summary of the 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
. - withText(String) - Method in class io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder
-
Adds the details description for a check run.
- 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.
All Classes and Interfaces|All Packages|Serialized Form
TruncatedString.buildByBytes(int)
orTruncatedString.buildByChars(int)
method according to your requirements.