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

Class Index

java.lang.Object

com.google.gerrit.server.restapi.account.Index

All Implemented Interfaces:

RestModifyView<AccountResource,Input>, RestView<AccountResource>

public class Index
extends Object
implements RestModifyView<AccountResource,Input>

REST endpoint to (re)index an account.

This REST endpoint handles POST /accounts/<account-identifier>/index requests.

If the document of an account in the account index is stale, this REST endpoint can be used to update the index.

Method Summary

Modifier and Type	Method	Description
Response<?>	apply(AccountResource rsrc, Input input)	Process the view operation by altering the resource.

Methods inherited from class java.lang.Object

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

Method Details

apply

public Response<?> apply(AccountResource rsrc,
 Input input)
                  throws IOException,
AuthException,
PermissionBackendException

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<AccountResource,Input>

Parameters:

rsrc - resource to modify

input - input after parsing from request

Returns:

response to return to the client

Throws:

AuthException - the caller is not permitted to access this view.

IOException

PermissionBackendException