Package com.google.gerrit.server.restapi.account

Class QueryAccounts

java.lang.Object

com.google.gerrit.server.restapi.account.QueryAccounts

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>

public class QueryAccounts
extends Object
implements RestReadView<TopLevelResource>

REST endpoint to query accounts.

This REST endpoint handles GET /accounts/ requests.

The account queries are parsed by AccountQueryBuilder and executed by AccountQueryProcessor.

Method Summary

Modifier and Type	Method	Description
void	addOption(ListAccountsOption o)
Response<List<AccountInfo>>	apply(TopLevelResource rsrc)	Process the view operation by reading from the resource.
void	setLimit(int n)
void	setQuery(String query)
void	setStart(int start)
void	setSuggest(boolean suggest)

Methods inherited from class java.lang.Object

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

Method Detail

setSuggest

public void setSuggest(boolean suggest)

setLimit

public void setLimit(int n)

addOption

public void addOption(ListAccountsOption o)

setQuery

public void setQuery(String query)

setStart

public void setStart(int start)

apply

public Response<List<AccountInfo>> apply(TopLevelResource rsrc)
                                  throws RestApiException,
                                         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<TopLevelResource>

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

PermissionBackendException