Package io.blueocean.rest.pipeline.editor

Class PipelineMetadataService

java.lang.Object

io.blueocean.rest.pipeline.editor.PipelineMetadataService

All Implemented Interfaces:

ExtensionPoint, io.jenkins.blueocean.rest.ApiRoutable, io.jenkins.blueocean.Routable

@Extension
public class PipelineMetadataService
extends Object
implements io.jenkins.blueocean.rest.ApiRoutable

This provides and Blueocean REST API endpoint to obtain pipeline step metadata. TODO: this should be provided off of the organization endpoint: e.g. /organization/:id/pipeline-metadata

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PipelineMetadataService()

Method Summary

Modifier and Type	Method	Description
ExportedDescribableModel[]	doAgentMetadata()	Function to return all DeclarativeAgents present in the system when accessed through the REST API
ExportedBuildCondition[]	doBuildConditions()	Function to return the names of all build conditions present in the system when accessed through the REST API
String	doCrumbInfo()
ExportedPipelineFunction[]	doPipelineStepMetadata()	Function to return all step descriptors present in the system when accessed through the REST API
ExportedToolDescriptor[]	doToolMetadata()	Function to return all ExportedToolDescriptors present in the system when accessed through the REST API, pipeline scripts need: symbol and name to specify tools
ExportedPipelineStep[]	doWrapperMetadata()	Function to return all applicable step descriptors for the "wrappers" section.
String	getUrlName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipelineMetadataService

public PipelineMetadataService()

Method Details

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface io.jenkins.blueocean.rest.ApiRoutable

Specified by:

getUrlName in interface io.jenkins.blueocean.Routable

doCrumbInfo

@GET
public String doCrumbInfo()

doAgentMetadata

@GET
public ExportedDescribableModel[] doAgentMetadata()

Function to return all DeclarativeAgents present in the system when accessed through the REST API

doToolMetadata

@GET
public ExportedToolDescriptor[] doToolMetadata()

Function to return all ExportedToolDescriptors present in the system when accessed through the REST API, pipeline scripts need: symbol and name to specify tools

doBuildConditions

@GET
public ExportedBuildCondition[] doBuildConditions()

Function to return the names of all build conditions present in the system when accessed through the REST API

doWrapperMetadata

@GET
public ExportedPipelineStep[] doWrapperMetadata()

Function to return all applicable step descriptors for the "wrappers" section.

doPipelineStepMetadata

@GET
public ExportedPipelineFunction[] doPipelineStepMetadata()

Function to return all step descriptors present in the system when accessed through the REST API