GetDashboard (Gerrit Review Plugin API Documentation)

java.lang.Object

com.google.gerrit.server.restapi.project.GetDashboard

All Implemented Interfaces:: RestReadView<DashboardResource>, RestView<DashboardResource>

public class GetDashboard extends Object implements RestReadView<DashboardResource>

Method Summary

Modifier and Type

Method

Description

Response<DashboardInfo>

apply(DashboardResource rsrc)

Process the view operation by reading from the resource.

GetDashboard

setInherited(boolean inherited)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- setInherited
  
  public GetDashboard setInherited(boolean inherited)
- apply
  
  public Response<DashboardInfo> apply(DashboardResource rsrc) throws RestApiException, IOException, PermissionBackendException
  
  Description copied from interface: RestReadView
  
  Process the view operation by reading from the resource.
  The value of the returned response is automatically converted to JSON unless it is a BinaryResult.
  The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).
  Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.
  
  Specified by:
  
  apply in interface RestReadView<DashboardResource>
  
  Parameters:
  
  rsrc - resource to read
  
  Returns:
  
  response to return to the client
  
  Throws:
  
  AuthException - the caller is not permitted to access this view.
  
  BadRequestException - the request was incorrectly specified and cannot be handled by this view.
  
  ResourceConflictException - the resource state does not permit this view to make the changes at this time.
  
  RestApiException
  
  IOException
  
  PermissionBackendException