More documentation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/87881e18 Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/87881e18 Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/87881e18 Branch: refs/heads/master Commit: 87881e180492f0534d7f6ed0f6f2f098d21ad851 Parents: 01c6b2c Author: Aaron McCurry <[email protected]> Authored: Fri Aug 16 18:46:22 2013 -0400 Committer: Aaron McCurry <[email protected]> Committed: Fri Aug 16 18:46:22 2013 -0400 ---------------------------------------------------------------------- .../org/apache/blur/thrift/generated/ErrorType.java | 8 ++++++++ .../java/org/apache/blur/thrift/generated/Status.java | 4 ++-- distribution/src/main/scripts/interface/Blur.thrift | 12 ++++++++++-- .../src/main/scripts/interface/gen-html/Blur.html | 12 +++++++++--- .../org/apache/blur/thrift/generated/ErrorType.java | 8 ++++++++ .../org/apache/blur/thrift/generated/Status.java | 4 ++-- 6 files changed, 39 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/blur-thrift/src/main/java/org/apache/blur/thrift/generated/ErrorType.java ---------------------------------------------------------------------- diff --git a/blur-thrift/src/main/java/org/apache/blur/thrift/generated/ErrorType.java b/blur-thrift/src/main/java/org/apache/blur/thrift/generated/ErrorType.java index 19e8e60..0e5dae6 100644 --- a/blur-thrift/src/main/java/org/apache/blur/thrift/generated/ErrorType.java +++ b/blur-thrift/src/main/java/org/apache/blur/thrift/generated/ErrorType.java @@ -30,6 +30,14 @@ import java.util.Map; import java.util.HashMap; import org.apache.blur.thirdparty.thrift_0_9_0.TEnum; +/** + * The error type of a BlurException.<br/><br/> + * UNKNOWN - Unknown error.<br/><br/> + * QUERY_CANCEL - Query has been cancel.<br/><br/> + * QUERY_TIMEOUT - Query has timed out.<br/><br/> + * BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/> + * REQUEST_TIMEOUT - The TCP connection has timed out.<br/> + */ public enum ErrorType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum { UNKNOWN(0), QUERY_CANCEL(1), http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Status.java ---------------------------------------------------------------------- diff --git a/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Status.java b/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Status.java index 7c3e0c2..2086772 100644 --- a/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Status.java +++ b/blur-thrift/src/main/java/org/apache/blur/thrift/generated/Status.java @@ -31,8 +31,8 @@ import java.util.HashMap; import org.apache.blur.thirdparty.thrift_0_9_0.TEnum; /** - * NOT_FOUND : when UUID is not found<br/><br/> - * FOUND : when UUID is present<br/> + * NOT_FOUND - when UUID is not found<br/><br/> + * FOUND - when UUID is present<br/> */ public enum Status implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum { NOT_FOUND(0), http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/distribution/src/main/scripts/interface/Blur.thrift ---------------------------------------------------------------------- diff --git a/distribution/src/main/scripts/interface/Blur.thrift b/distribution/src/main/scripts/interface/Blur.thrift index d39e19c..c5a4cb3 100644 --- a/distribution/src/main/scripts/interface/Blur.thrift +++ b/distribution/src/main/scripts/interface/Blur.thrift @@ -19,6 +19,14 @@ namespace java org.apache.blur.thrift.generated namespace rb blur namespace perl Blur +/** + * The error type of a BlurException.<br/><br/> + * UNKNOWN - Unknown error.<br/><br/> + * QUERY_CANCEL - Query has been cancel.<br/><br/> + * QUERY_TIMEOUT - Query has timed out.<br/><br/> + * BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/> + * REQUEST_TIMEOUT - The TCP connection has timed out.<br/> + */ enum ErrorType { UNKNOWN, QUERY_CANCEL, @@ -73,8 +81,8 @@ enum QueryState { } /** - * NOT_FOUND : when UUID is not found<br/><br/> - * FOUND : when UUID is present<br/> + * NOT_FOUND - when UUID is not found<br/><br/> + * FOUND - when UUID is present<br/> */ enum Status { NOT_FOUND, http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/distribution/src/main/scripts/interface/gen-html/Blur.html ---------------------------------------------------------------------- diff --git a/distribution/src/main/scripts/interface/gen-html/Blur.html b/distribution/src/main/scripts/interface/gen-html/Blur.html index 3da5cce..fb55bb9 100644 --- a/distribution/src/main/scripts/interface/gen-html/Blur.html +++ b/distribution/src/main/scripts/interface/gen-html/Blur.html @@ -77,7 +77,13 @@ </tr></table> <hr/><h2 id="Enumerations">Enumerations</h2> <div class="definition"><h3 id="Enum_ErrorType">Enumeration: ErrorType</h3> -<br/><table class="table-bordered table-striped table-condensed"> +The error type of a BlurException.<br/><br/> +UNKNOWN - Unknown error.<br/><br/> +QUERY_CANCEL - Query has been cancel.<br/><br/> +QUERY_TIMEOUT - Query has timed out.<br/><br/> +BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/> +REQUEST_TIMEOUT - The TCP connection has timed out.<br/> +<br/><br/><table class="table-bordered table-striped table-condensed"> <tr><td><code>UNKNOWN</code></td><td><code>0</code></td></tr> <tr><td><code>QUERY_CANCEL</code></td><td><code>1</code></td></tr> <tr><td><code>QUERY_TIMEOUT</code></td><td><code>2</code></td></tr> @@ -108,8 +114,8 @@ COMPLETE - Query is complete.<br/> <tr><td><code>BACK_PRESSURE_INTERRUPTED</code></td><td><code>3</code></td></tr> </table></div> <div class="definition"><h3 id="Enum_Status">Enumeration: Status</h3> -NOT_FOUND : when UUID is not found<br/><br/> -FOUND : when UUID is present<br/> +NOT_FOUND - when UUID is not found<br/><br/> +FOUND - when UUID is present<br/> <br/><br/><table class="table-bordered table-striped table-condensed"> <tr><td><code>NOT_FOUND</code></td><td><code>0</code></td></tr> <tr><td><code>FOUND</code></td><td><code>1</code></td></tr> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java ---------------------------------------------------------------------- diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java index 19e8e60..0e5dae6 100644 --- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java +++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/ErrorType.java @@ -30,6 +30,14 @@ import java.util.Map; import java.util.HashMap; import org.apache.blur.thirdparty.thrift_0_9_0.TEnum; +/** + * The error type of a BlurException.<br/><br/> + * UNKNOWN - Unknown error.<br/><br/> + * QUERY_CANCEL - Query has been cancel.<br/><br/> + * QUERY_TIMEOUT - Query has timed out.<br/><br/> + * BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/> + * REQUEST_TIMEOUT - The TCP connection has timed out.<br/> + */ public enum ErrorType implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum { UNKNOWN(0), QUERY_CANCEL(1), http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/87881e18/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java ---------------------------------------------------------------------- diff --git a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java index 7c3e0c2..2086772 100644 --- a/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java +++ b/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/Status.java @@ -31,8 +31,8 @@ import java.util.HashMap; import org.apache.blur.thirdparty.thrift_0_9_0.TEnum; /** - * NOT_FOUND : when UUID is not found<br/><br/> - * FOUND : when UUID is present<br/> + * NOT_FOUND - when UUID is not found<br/><br/> + * FOUND - when UUID is present<br/> */ public enum Status implements org.apache.blur.thirdparty.thrift_0_9_0.TEnum { NOT_FOUND(0),
