com.atlassian.jira.rest.v2.index.summary

Class IndexSummaryResource

java.lang.Object

com.atlassian.jira.rest.v2.index.summary.IndexSummaryResource

public class IndexSummaryResource
extends Object

REST resource for index summary

Since:

v7.2.10

Constructor Summary

Constructors

Constructor and Description
IndexSummaryResource(ResponseFactory responseFactory, ClusterManager clusterManager, IndexSummarizer indexSummarizer)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getIndexSummary() Summarizes index condition of current node.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexSummaryResource

public IndexSummaryResource(ResponseFactory responseFactory,
                            ClusterManager clusterManager,
                            IndexSummarizer indexSummarizer)

Method Detail

getIndexSummary

@ExperimentalApi
public javax.ws.rs.core.Response getIndexSummary()

Summarizes index condition of current node.

Returned data consists of:

• nodeId - Node identifier.
• reportTime - Time of this report creation.
• issueIndex - Summary of issue index status.
• replicationQueues - Map of index replication queues, where keys represent nodes from which replication operations came from.

issueIndex can contain:

• indexReadable - If false the end point failed to read data from issue index (check JIRA logs for detailed stack trace), otherwise true. When false other fields of issueIndex can be not visible.
• countInDatabase - Count of issues found in database.
• countInIndex - Count of issues found while querying index.
• lastUpdatedInDatabase - Time of last update of issue found in database.
• lastUpdatedInIndex - Time of last update of issue found while querying index.

replicationQueues's map values can contain:

• lastConsumedOperation - Last executed index replication operation by current node from sending node's queue.
• lastConsumedOperation.id - Identifier of the operation.
• lastConsumedOperation.replicationTime - Time when the operation was sent to other nodes.
• lastOperationInQueue - Last index replication operation in sending node's queue.
• lastOperationInQueue.id - Identifier of the operation.
• lastOperationInQueue.replicationTime - Time when the operation was sent to other nodes.
• queueSize - Number of operations in queue from sending node to current node.

Returns:

Response containing JSON object with data about index condition