com.atlassian.jira.rest.v2.index

Class ReindexRequestResource

java.lang.Object

com.atlassian.jira.rest.v2.index.ReindexRequestResource

public class ReindexRequestResource
extends Object

REST resource for querying and executing reindex requests.

Since:

6.4

Constructor Summary

Constructors

Constructor and Description
ReindexRequestResource(ReindexRequestService reindexRequestService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getProgress(long requestId) Retrieves the progress of a single reindex request.
List<ReindexRequestBean>	getProgressBulk(Set<Long> requestIds) Retrieves the progress of a multiple reindex requests.
javax.ws.rs.core.Response	processRequests() Executes any pending reindex requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReindexRequestResource

public ReindexRequestResource(ReindexRequestService reindexRequestService)

Method Detail

processRequests

public javax.ws.rs.core.Response processRequests()

Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through other REST calls.

Returns:

JSON array containing the IDs of the reindex requests that are being processed.

getProgress

public javax.ws.rs.core.Response getProgress(long requestId)

Retrieves the progress of a single reindex request.

Parameters:

requestId - the reindex request ID.

Returns:

details and status of the reindex request.

getProgressBulk

public List<ReindexRequestBean> getProgressBulk(Set<Long> requestIds)

Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned in the results.

Parameters:

requestIds - the reindex request IDs.

Returns:

an array of results describing the progress of each of the found requests.