Package com.google.gerrit.extensions.api.projects

Class Projects.QueryRequest

java.lang.Object

com.google.gerrit.extensions.api.projects.Projects.QueryRequest

Enclosing interface:

Projects

public abstract static class Projects.QueryRequest
extends Object

API for setting parameters and getting result. Used for query().

See Also:

• Projects.query()

Constructor Summary

Constructors

Constructor	Description
QueryRequest()

Method Summary

Modifier and Type	Method	Description
abstract List<ProjectInfo>	get()	Execute query and returns the matched projects as list.
int	getLimit()
String	getQuery()
int	getStart()
Projects.QueryRequest	withLimit(int limit)	Set limit for returned list of projects.
Projects.QueryRequest	withQuery(String query)	Set query.
Projects.QueryRequest	withStart(int start)	Set number of projects to skip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryRequest

public QueryRequest()

Method Details

get

public abstract List<ProjectInfo> get()
                               throws RestApiException

Execute query and returns the matched projects as list.

Throws:

RestApiException

withQuery

public Projects.QueryRequest withQuery(String query)

Set query.

Parameters:

query - needs to be in human-readable form.

withLimit

public Projects.QueryRequest withLimit(int limit)

Set limit for returned list of projects. Optional; server-default is used when not provided.

withStart

public Projects.QueryRequest withStart(int start)

Set number of projects to skip. Optional; no projects are skipped when not provided.

getQuery

public String getQuery()

getLimit

public int getLimit()

getStart

public int getStart()