Google Git
Sign in
apache / kafka-site / asf-site / . / 35 / javadoc / org / apache / kafka / streams / query / QueryResult.html
blob: 18aefd0a6378974f879551fe6f4fe92c499b6524 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>QueryResult (kafka 3.5.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.kafka.streams.query, interface: QueryResult">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.kafka.streams.query</a></div>
<h1 title="Interface QueryResult" class="title">Interface QueryResult&lt;R&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>R</code> - The result type of the query.</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryResult&lt;R&gt;</span></div>
<div class="block">Container for a single partition's result when executing a <a href="StateQueryRequest.html" title="class in org.apache.kafka.streams.query"><code>StateQueryRequest</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addExecutionInfo(java.lang.String)" class="member-name-link">addExecutionInfo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;message)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Used by stores to add detailed execution information (if requested) during query execution.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static &lt;R&gt;&nbsp;<a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#forFailure(org.apache.kafka.streams.query.FailureReason,java.lang.String)" class="member-name-link">forFailure</a><wbr>(<a href="FailureReason.html" title="enum class in org.apache.kafka.streams.query">FailureReason</a>&nbsp;failureReason,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;failureMessage)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">Static factory method to create a result object for a failed query.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static &lt;R&gt;&nbsp;<a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#forResult(R)" class="member-name-link">forResult</a><wbr>(R&nbsp;result)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
<div class="block">Static factory method to create a result object for a successful query.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static &lt;R&gt;&nbsp;<a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#forUnknownQueryType(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.processor.StateStore)" class="member-name-link">forUnknownQueryType</a><wbr>(<a href="Query.html" title="interface in org.apache.kafka.streams.query">Query</a>&lt;R&gt;&nbsp;query,
<a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&nbsp;store)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">Static factory method to create a failed query result object to indicate that the store does
not know how to handle the query.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getExecutionInfo()" class="member-name-link">getExecutionInfo</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">If detailed execution information was requested in <a href="StateQueryRequest.html#enableExecutionInfo()"><code>StateQueryRequest.enableExecutionInfo()</code></a>,
this method returned the execution details for this partition's result.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFailureMessage()" class="member-name-link">getFailureMessage</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">If this partition failed to execute the query, returns the failure message.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FailureReason.html" title="enum class in org.apache.kafka.streams.query">FailureReason</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFailureReason()" class="member-name-link">getFailureReason</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">If this partition failed to execute the query, returns the reason.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">This state partition's exact position in its history when this query was executed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="QueryResult.html" title="type parameter in QueryResult">R</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResult()" class="member-name-link">getResult</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the result of executing the query on one partition.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isFailure()" class="member-name-link">isFailure</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">True iff the query execution failed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSuccess()" class="member-name-link">isSuccess</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">True iff the query was successfully executed.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static &lt;R&gt;&nbsp;<a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#notUpToBound(org.apache.kafka.streams.query.Position,org.apache.kafka.streams.query.PositionBound,java.lang.Integer)" class="member-name-link">notUpToBound</a><wbr>(<a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a>&nbsp;currentPosition,
<a href="PositionBound.html" title="class in org.apache.kafka.streams.query">PositionBound</a>&nbsp;positionBound,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&nbsp;partition)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">Static factory method to create a failed query result object to indicate that the store has
not yet caught up to the requested position bound.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setPosition(org.apache.kafka.streams.query.Position)" class="member-name-link">setPosition</a><wbr>(<a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a>&nbsp;position)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Used by stores to report what exact position in the store's history it was at when it
executed the query.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="forResult(R)">
<h3 id="forResult(java.lang.Object)">forResult</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type"><a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</span>&nbsp;<span class="element-name">forResult</span><wbr><span class="parameters">(R&nbsp;result)</span></div>
<div class="block">Static factory method to create a result object for a successful query. Used by StateStores
to respond to a <a href="../processor/StateStore.html#query(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.query.PositionBound,org.apache.kafka.streams.query.QueryConfig)"><code>StateStore.query(Query, PositionBound, QueryConfig)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="forFailure(org.apache.kafka.streams.query.FailureReason,java.lang.String)">
<h3>forFailure</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type"><a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</span>&nbsp;<span class="element-name">forFailure</span><wbr><span class="parameters">(<a href="FailureReason.html" title="enum class in org.apache.kafka.streams.query">FailureReason</a>&nbsp;failureReason,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;failureMessage)</span></div>
<div class="block">Static factory method to create a result object for a failed query. Used by StateStores to
respond to a <a href="../processor/StateStore.html#query(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.query.PositionBound,org.apache.kafka.streams.query.QueryConfig)"><code>StateStore.query(Query, PositionBound, QueryConfig)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="forUnknownQueryType(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.processor.StateStore)">
<h3>forUnknownQueryType</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type"><a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</span>&nbsp;<span class="element-name">forUnknownQueryType</span><wbr><span class="parameters">(<a href="Query.html" title="interface in org.apache.kafka.streams.query">Query</a>&lt;R&gt;&nbsp;query,
<a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&nbsp;store)</span></div>
<div class="block">Static factory method to create a failed query result object to indicate that the store does
not know how to handle the query.
<p>
Used by StateStores to respond to a <a href="../processor/StateStore.html#query(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.query.PositionBound,org.apache.kafka.streams.query.QueryConfig)"><code>StateStore.query(Query, PositionBound, QueryConfig)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="notUpToBound(org.apache.kafka.streams.query.Position,org.apache.kafka.streams.query.PositionBound,java.lang.Integer)">
<h3>notUpToBound</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="type-parameters">&lt;R&gt;</span>&nbsp;<span class="return-type"><a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a>&lt;R&gt;</span>&nbsp;<span class="element-name">notUpToBound</span><wbr><span class="parameters">(<a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a>&nbsp;currentPosition,
<a href="PositionBound.html" title="class in org.apache.kafka.streams.query">PositionBound</a>&nbsp;positionBound,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&nbsp;partition)</span></div>
<div class="block">Static factory method to create a failed query result object to indicate that the store has
not yet caught up to the requested position bound.
<p>
Used by StateStores to respond to a <a href="../processor/StateStore.html#query(org.apache.kafka.streams.query.Query,org.apache.kafka.streams.query.PositionBound,org.apache.kafka.streams.query.QueryConfig)"><code>StateStore.query(Query, PositionBound, QueryConfig)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="addExecutionInfo(java.lang.String)">
<h3>addExecutionInfo</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">addExecutionInfo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;message)</span></div>
<div class="block">Used by stores to add detailed execution information (if requested) during query execution.</div>
</section>
</li>
<li>
<section class="detail" id="setPosition(org.apache.kafka.streams.query.Position)">
<h3>setPosition</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setPosition</span><wbr><span class="parameters">(<a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a>&nbsp;position)</span></div>
<div class="block">Used by stores to report what exact position in the store's history it was at when it
executed the query.</div>
</section>
</li>
<li>
<section class="detail" id="isSuccess()">
<h3>isSuccess</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isSuccess</span>()</div>
<div class="block">True iff the query was successfully executed. The response is available in <a href="#getResult()"><code>getResult()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="isFailure()">
<h3>isFailure</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isFailure</span>()</div>
<div class="block">True iff the query execution failed. More information about the failure is available in
<a href="#getFailureReason()"><code>getFailureReason()</code></a> and <a href="#getFailureMessage()"><code>getFailureMessage()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="getExecutionInfo()">
<h3>getExecutionInfo</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getExecutionInfo</span>()</div>
<div class="block">If detailed execution information was requested in <a href="StateQueryRequest.html#enableExecutionInfo()"><code>StateQueryRequest.enableExecutionInfo()</code></a>,
this method returned the execution details for this partition's result.</div>
</section>
</li>
<li>
<section class="detail" id="getPosition()">
<h3>getPosition</h3>
<div class="member-signature"><span class="return-type"><a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a></span>&nbsp;<span class="element-name">getPosition</span>()</div>
<div class="block">This state partition's exact position in its history when this query was executed. Can be
used in conjunction with subsequent queries via <a href="StateQueryRequest.html#withPositionBound(org.apache.kafka.streams.query.PositionBound)"><code>StateQueryRequest.withPositionBound(PositionBound)</code></a>.
<p>
Note: stores are encouraged, but not required to set this property.</div>
</section>
</li>
<li>
<section class="detail" id="getFailureReason()">
<h3>getFailureReason</h3>
<div class="member-signature"><span class="return-type"><a href="FailureReason.html" title="enum class in org.apache.kafka.streams.query">FailureReason</a></span>&nbsp;<span class="element-name">getFailureReason</span>()</div>
<div class="block">If this partition failed to execute the query, returns the reason.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this is not a failed result.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFailureMessage()">
<h3>getFailureMessage</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getFailureMessage</span>()</div>
<div class="block">If this partition failed to execute the query, returns the failure message.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this is not a failed result.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getResult()">
<h3>getResult</h3>
<div class="member-signature"><span class="return-type"><a href="QueryResult.html" title="type parameter in QueryResult">R</a></span>&nbsp;<span class="element-name">getResult</span>()</div>
<div class="block">Returns the result of executing the query on one partition. The result type is determined by
the query. Note: queries may choose to return <code>null</code> for a successful query, so <a href="#isSuccess()"><code>isSuccess()</code></a> and <a href="#isFailure()"><code>isFailure()</code></a> must be used to determine whether the query
was successful of failed on this partition.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this is not a successful query.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>