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

  • Field Details

  • Constructor Details

    • ApiHead

      public ApiHead()

  • Method Details

    • 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()
      This ApiHead gets bound to "/rest"
      Specified by:
      getUrlName in interface Routable

    • getDynamic

      public ApiRoutable getDynamic(String route)
      Exposes all ApiRoutables to URL space.
      Parameters:
      route - current URL route handled by ApiHead
      Returns:
      ApiRoutable object

    • getLink

      public Link getLink()
      Specified by:
      getLink in interface Reachable
      Returns:
      Gives Link to a reachable Resource or Container

    • 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.