Extension Points defined in REST Implementation for Blue Ocean Plugin

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

REST Implementation for Blue Ocean Plugin

ContainerFilter

jenkinsdoc:blueocean-rest-impl:io.jenkins.blueocean.service.embedded.rest.ContainerFilter]

Simple extension point to allow filtering item types by a specific key This can be used anywhere a list of items are returned, and it will examine the current request for a ?filter=filter1(param:value),filter2 parameter, okay the last bit is a future addition once/if OmniSearch and this are consolidated

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.PipelineJobFilters.FolderJobFilter (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.PipelineJobFilters.OriginFilter (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.PipelineJobFilters.PullRequestFilter (view on GitHub)

JobAnalyticsCheck

jenkinsdoc:blueocean-rest-impl:io.jenkins.blueocean.service.embedded.analytics.JobAnalyticsCheck]

Used to check the type of item for jenkinsdoc:io.jenkins.blueocean.service.embedded.analytics.JobAnalytics]

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.DeclarativePipelineAnalyticsCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.DeclarativeSinglePipelineCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.FreeStyleAnalyticsCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.MatrixAnalyticsCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.MavenAnalyticsCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.ScriptedPipelineAnalyticsCheck (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.ScriptedSinglePipelineCheck (view on GitHub)

JobAnalyticsExclude

jenkinsdoc:blueocean-rest-impl:io.jenkins.blueocean.service.embedded.analytics.JobAnalyticsExclude]

Used to exclude an item from jenkinsdoc:io.jenkins.blueocean.service.embedded.analytics.JobAnalytics]

Implementations:

Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.MatrixAnalyticsCheck.ExcludeImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.MavenAnalyticsCheck.ExcludeImpl (view on GitHub)
Pipeline implementation for Blue Ocean Plugin: io.jenkins.blueocean.rest.impl.pipeline.analytics.ScriptedPipelineAnalyticsCheck.ExcludeImpl (view on GitHub)

KeenConfiguration

jenkinsdoc:blueocean-rest-impl:io.jenkins.blueocean.service.embedded.analytics.KeenConfiguration]

This extension point has no Javadoc documentation.

Implementations:

REST Implementation for Blue Ocean Plugin: io.jenkins.blueocean.service.embedded.analytics.KeenConfiguration.DefaultKeenConfiguration (view on GitHub)