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

Interface ListProjects

All Superinterfaces:
RestReadView<TopLevelResource>, RestView<TopLevelResource>
All Known Implementing Classes:
AbstractListProjects, ListProjectsImpl
public interface ListProjects extends RestReadView<TopLevelResource>
List projects visible to the calling user.

Implement GET /projects/, without a query= parameter.

  • Method Details

    • setFormat

      void setFormat(com.google.gerrit.json.OutputFormat fmt)

    • addShowBranch

      void addShowBranch(String branch)

    • setShowTree

      void setShowTree(boolean showTree)

    • setFilterType

      void setFilterType(ListProjects.FilterType type)

    • setShowDescription

      void setShowDescription(boolean showDescription)

    • setAll

      void setAll(boolean all)

    • setState

      void setState(ProjectState state)

    • setLimit

      void setLimit(int limit)

    • setStart

      void setStart(int start)

    • setMatchPrefix

      void setMatchPrefix(String matchPrefix)

    • setMatchSubstring

      void setMatchSubstring(String matchSubstring)

    • setMatchRegex

      void setMatchRegex(String matchRegex)

    • setGroupUuid

      void setGroupUuid(AccountGroup.UUID groupUuid)

    • apply

      default Response<Object> apply(TopLevelResource resource) throws Exception
      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<TopLevelResource>
      Parameters:
      resource - 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.
      Exception - the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.

    • apply

      SortedMap<String,ProjectInfo> apply() throws Exception
      Throws:
      Exception