Package io.jenkins.blueocean.rest
Class ApiHead
- java.lang.Object
-
- io.jenkins.blueocean.rest.ApiHead
-
- All Implemented Interfaces:
ExtensionPoint
,Reachable
,RootRoutable
,Routable
@Extension public final class ApiHead extends Object implements RootRoutable, Reachable
Entrypoint for blueocean REST apis. $CONTEXT_PATH/rest being root. e.g. /jenkins/rest- Author:
- Vivek Pandey
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description ApiHead()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiRoutable
getDynamic(String route)
Exposes allApiRoutable
s to URL space.Link
getLink()
String
getUrlName()
ThisApiHead
gets bound to "/rest"static ApiHead
INSTANCE()
Gives instance of ApiHead by looking in to Extensions.Pageable<?>
search(Query query)
Search API Gives collection starting from start parameter value with max numbers <= limit
-
-
-
Field Detail
-
URL_NAME
public static final String URL_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
search
@WebMethod(name="search") @GET public Pageable<?> search(@QueryParameter("q") Query query)
Search API Gives collection starting from start parameter value with max numbers <= limit- Parameters:
query
- query object parsed from value of q URL query parameter- Returns:
- Gives pageable collection always non-null
-
getUrlName
public String getUrlName()
ThisApiHead
gets bound to "/rest"- Specified by:
getUrlName
in interfaceRoutable
-
getDynamic
public ApiRoutable getDynamic(String route)
Exposes allApiRoutable
s to URL space.- Parameters:
route
- current URL route handled by ApiHead- Returns:
ApiRoutable
object
-
getLink
public Link getLink()
-
INSTANCE
public static ApiHead INSTANCE()
Gives instance of ApiHead by looking in to Extensions. In some cases it might be null, such as when jenkins is booting up.
-
-