blob: 5129c31b53ce8e1646bcc77ed361e2b90f3cd4ab [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Responses.ErrorResponseOrBuilder (Apache Calcite Avatica API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Responses.ErrorResponseOrBuilder (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Responses.ErrorResponseOrBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponse.Builder.html" title="class in org.apache.calcite.avatica.proto"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ExecuteBatchResponse.html" title="class in org.apache.calcite.avatica.proto"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Responses.ErrorResponseOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.avatica.proto</div>
<h2 title="Interface Responses.ErrorResponseOrBuilder" class="title">Interface Responses.ErrorResponseOrBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponse.html" title="class in org.apache.calcite.avatica.proto">Responses.ErrorResponse</a>, <a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponse.Builder.html" title="class in org.apache.calcite.avatica.proto">Responses.ErrorResponse.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/calcite/avatica/proto/Responses.html" title="class in org.apache.calcite.avatica.proto">Responses</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">Responses.ErrorResponseOrBuilder</span>
extends com.google.protobuf.MessageOrBuilder</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getErrorCode--">getErrorCode</a></span>()</code>
<div class="block">
numeric identifier for error</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getErrorMessage--">getErrorMessage</a></span>()</code>
<div class="block">
human readable description</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getErrorMessageBytes--">getErrorMessageBytes</a></span>()</code>
<div class="block">
human readable description</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getExceptions-int-">getExceptions</a></span>(int&nbsp;index)</code>
<div class="block">
exception stacktraces, many for linked exceptions.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getExceptionsBytes-int-">getExceptionsBytes</a></span>(int&nbsp;index)</code>
<div class="block">
exception stacktraces, many for linked exceptions.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getExceptionsCount--">getExceptionsCount</a></span>()</code>
<div class="block">
exception stacktraces, many for linked exceptions.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getExceptionsList--">getExceptionsList</a></span>()</code>
<div class="block">
exception stacktraces, many for linked exceptions.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getHasExceptions--">getHasExceptions</a></span>()</code>
<div class="block">
are there stacktraces contained?</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/proto/Responses.RpcMetadata.html" title="class in org.apache.calcite.avatica.proto">Responses.RpcMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getMetadata--">getMetadata</a></span>()</code>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/proto/Responses.RpcMetadataOrBuilder.html" title="interface in org.apache.calcite.avatica.proto">Responses.RpcMetadataOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getMetadataOrBuilder--">getMetadataOrBuilder</a></span>()</code>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/proto/Common.Severity.html" title="enum in org.apache.calcite.avatica.proto">Common.Severity</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getSeverity--">getSeverity</a></span>()</code>
<div class="block"><code>.Severity severity = 3;</code></div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getSeverityValue--">getSeverityValue</a></span>()</code>
<div class="block"><code>.Severity severity = 3;</code></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getSqlState--">getSqlState</a></span>()</code>
<div class="block">
five-character standard-defined value</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#getSqlStateBytes--">getSqlStateBytes</a></span>()</code>
<div class="block">
five-character standard-defined value</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html#hasMetadata--">hasMetadata</a></span>()</code>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.MessageOrBuilder</h3>
<code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.MessageLiteOrBuilder</h3>
<code>isInitialized</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getExceptionsList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExceptionsList</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getExceptionsList()</pre>
<div class="block"><pre>
exception stacktraces, many for linked exceptions.
</pre>
<code>repeated string exceptions = 1;</code></div>
</li>
</ul>
<a name="getExceptionsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExceptionsCount</h4>
<pre>int&nbsp;getExceptionsCount()</pre>
<div class="block"><pre>
exception stacktraces, many for linked exceptions.
</pre>
<code>repeated string exceptions = 1;</code></div>
</li>
</ul>
<a name="getExceptions-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExceptions</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getExceptions(int&nbsp;index)</pre>
<div class="block"><pre>
exception stacktraces, many for linked exceptions.
</pre>
<code>repeated string exceptions = 1;</code></div>
</li>
</ul>
<a name="getExceptionsBytes-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExceptionsBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getExceptionsBytes(int&nbsp;index)</pre>
<div class="block"><pre>
exception stacktraces, many for linked exceptions.
</pre>
<code>repeated string exceptions = 1;</code></div>
</li>
</ul>
<a name="getHasExceptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHasExceptions</h4>
<pre>boolean&nbsp;getHasExceptions()</pre>
<div class="block"><pre>
are there stacktraces contained?
</pre>
<code>bool has_exceptions = 7;</code></div>
</li>
</ul>
<a name="getErrorMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessage</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getErrorMessage()</pre>
<div class="block"><pre>
human readable description
</pre>
<code>string error_message = 2;</code></div>
</li>
</ul>
<a name="getErrorMessageBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessageBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getErrorMessageBytes()</pre>
<div class="block"><pre>
human readable description
</pre>
<code>string error_message = 2;</code></div>
</li>
</ul>
<a name="getSeverityValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeverityValue</h4>
<pre>int&nbsp;getSeverityValue()</pre>
<div class="block"><code>.Severity severity = 3;</code></div>
</li>
</ul>
<a name="getSeverity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeverity</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/proto/Common.Severity.html" title="enum in org.apache.calcite.avatica.proto">Common.Severity</a>&nbsp;getSeverity()</pre>
<div class="block"><code>.Severity severity = 3;</code></div>
</li>
</ul>
<a name="getErrorCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorCode</h4>
<pre>int&nbsp;getErrorCode()</pre>
<div class="block"><pre>
numeric identifier for error
</pre>
<code>uint32 error_code = 4;</code></div>
</li>
</ul>
<a name="getSqlState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSqlState</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSqlState()</pre>
<div class="block"><pre>
five-character standard-defined value
</pre>
<code>string sql_state = 5;</code></div>
</li>
</ul>
<a name="getSqlStateBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSqlStateBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getSqlStateBytes()</pre>
<div class="block"><pre>
five-character standard-defined value
</pre>
<code>string sql_state = 5;</code></div>
</li>
</ul>
<a name="hasMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMetadata</h4>
<pre>boolean&nbsp;hasMetadata()</pre>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</li>
</ul>
<a name="getMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/proto/Responses.RpcMetadata.html" title="class in org.apache.calcite.avatica.proto">Responses.RpcMetadata</a>&nbsp;getMetadata()</pre>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</li>
</ul>
<a name="getMetadataOrBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMetadataOrBuilder</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/proto/Responses.RpcMetadataOrBuilder.html" title="interface in org.apache.calcite.avatica.proto">Responses.RpcMetadataOrBuilder</a>&nbsp;getMetadataOrBuilder()</pre>
<div class="block"><code>.RpcMetadata metadata = 6;</code></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Responses.ErrorResponseOrBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ErrorResponse.Builder.html" title="class in org.apache.calcite.avatica.proto"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/proto/Responses.ExecuteBatchResponse.html" title="class in org.apache.calcite.avatica.proto"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/proto/Responses.ErrorResponseOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Responses.ErrorResponseOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>