(accumulo) branch 2.1 updated: documents ScanStat enum values (#4827)

[kturner]

This is an automated email from the ASF dual-hosted git repository.

kturner pushed a commit to branch 2.1
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/2.1 by this push:
     new 8ba3f2cb74 documents ScanStat enum values (#4827)
8ba3f2cb74 is described below

commit 8ba3f2cb7461a6871cbf159decaa9dccad71b31d
Author: Keith Turner <ktur...@apache.org>
AuthorDate: Sat Aug 24 09:33:13 2024 -0700

    documents ScanStat enum values (#4827)
---
 .../apache/accumulo/core/client/admin/ScanState.java    | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git 
a/core/src/main/java/org/apache/accumulo/core/client/admin/ScanState.java 
b/core/src/main/java/org/apache/accumulo/core/client/admin/ScanState.java
index 7fbe2f28bb..b62482fbcf 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/admin/ScanState.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/admin/ScanState.java
@@ -19,5 +19,20 @@
 package org.apache.accumulo.core.client.admin;
 
 public enum ScanState {
-  IDLE, RUNNING, QUEUED
+  /**
+   * Indicates no work is currently queued or running to fetch the next batch 
of key/values for a
+   * scan. This could be because the server is waiting for a client to 
retrieve a batch of
+   * key/values its has already fetched and is buffering.
+   */
+  IDLE,
+  /**
+   * Indicates a task is running in a server side thread pool to fetch the 
next batch of key/values
+   * for a scan.
+   */
+  RUNNING,
+  /**
+   * Indicates a task is queued in a server side thread pool to fetch the next 
bach of key/values
+   * for a scan.
+   */
+  QUEUED
 }