Package com.google.gerrit.server.restapi.project

Class GarbageCollect

java.lang.Object
com.google.gerrit.server.restapi.project.GarbageCollect
All Implemented Interfaces:
RestModifyView<ProjectResource,GarbageCollect.Input>, RestView<ProjectResource>, UiAction<ProjectResource>
public class GarbageCollect extends Object implements RestModifyView<ProjectResource,GarbageCollect.Input>, UiAction<ProjectResource>
REST endpoint that executes GC on a project.

  • Method Details

    • apply

      public Response<?> apply(ProjectResource rsrc, GarbageCollect.Input input)
      Description copied from interface: RestModifyView
      Process the view operation by altering 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 RestModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 202 Accepted if a background task was scheduled, 204 No Content if no content is returned, 302 Found for a redirect).

      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 RestModifyView<ProjectResource,GarbageCollect.Input>
      Parameters:
      rsrc - resource to modify
      input - input after parsing from request
      Returns:
      response to return to the client

    • getDescription

      public UiAction.Description getDescription(ProjectResource rsrc)
      Description copied from interface: UiAction
      Get the description of the action customized for the resource.
      Specified by:
      getDescription in interface UiAction<ProjectResource>
      Parameters:
      rsrc - the resource the view would act upon if the action is invoked by the client. Information from the resource can be used to customize the description.
      Returns:
      a description of the action. The server will populate the id and method properties. If null the action will assumed unavailable and not presented. This is usually the same as setVisible(false).