<! doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>PreparedQueryExecuteOptions | @vertx/consul-client</title>
	<meta name="description" content="Documentation for @vertx/consul-client">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@vertx/consul-client</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="preparedqueryexecuteoptions.html">PreparedQueryExecuteOptions</a>
				</li>
			</ul>
			<h1>Class PreparedQueryExecuteOptions</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Options used to execute prepared query</p>
					</div>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">PreparedQueryExecuteOptions</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Constructors</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="preparedqueryexecuteoptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Methods</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedqueryexecuteoptions.html#getlimit" class="tsd-kind-icon">get<wbr>Limit</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedqueryexecuteoptions.html#getnear" class="tsd-kind-icon">get<wbr>Near</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedqueryexecuteoptions.html#setlimit" class="tsd-kind-icon">set<wbr>Limit</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedqueryexecuteoptions.html#setnear" class="tsd-kind-icon">set<wbr>Near</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Constructors</h2>
				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
					<a name="constructor" class="tsd-anchor"></a>
					<h3>constructor</h3>
					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">new <wbr>Prepared<wbr>Query<wbr>Execute<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></li>
						<li class="tsd-signature tsd-kind-icon">new <wbr>Prepared<wbr>Query<wbr>Execute<wbr>Options<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2041</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></h4>
						</li>
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2043</li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>obj: <a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></h4>
						</li>
					</ul>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Methods</h2>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getlimit" class="tsd-anchor"></a>
					<h3>get<wbr>Limit</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Limit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2050</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the size of the list to the given number of nodes.  This is applied after any sorting or shuffling.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getnear" class="tsd-anchor"></a>
					<h3>get<wbr>Near</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Near<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2062</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set node name for sorting the list in ascending order based on the estimated round trip time from that node. 
										Passing <code>_agent</code> will use the agent&#39;s node for the sort.  If this is not present,
									the default behavior will shuffle the nodes randomly each time the query is executed.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setlimit" class="tsd-anchor"></a>
					<h3>set<wbr>Limit</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Limit<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2055</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the size of the list to the given number of nodes.  This is applied after any sorting or shuffling.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>limit: <span class="tsd-signature-type">number</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setnear" class="tsd-anchor"></a>
					<h3>set<wbr>Near</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Near<span class="tsd-signature-symbol">(</span>near<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2069</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set node name for sorting the list in ascending order based on the estimated round trip time from that node. 
										Passing <code>_agent</code> will use the agent&#39;s node for the sort.  If this is not present,
									the default behavior will shuffle the nodes randomly each time the query is executed.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>near: <span class="tsd-signature-type">string</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedqueryexecuteoptions.html" class="tsd-signature-type">PreparedQueryExecuteOptions</a></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="preparedqueryexecuteoptions.html" class="tsd-kind-icon">Prepared<wbr>Query<wbr>Execute<wbr>Options</a>
						<ul>
							<li class=" tsd-kind-constructor tsd-parent-kind-class">
								<a href="preparedqueryexecuteoptions.html#constructor" class="tsd-kind-icon">constructor</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedqueryexecuteoptions.html#getlimit" class="tsd-kind-icon">get<wbr>Limit</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedqueryexecuteoptions.html#getnear" class="tsd-kind-icon">get<wbr>Near</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedqueryexecuteoptions.html#setlimit" class="tsd-kind-icon">set<wbr>Limit</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedqueryexecuteoptions.html#setnear" class="tsd-kind-icon">set<wbr>Near</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>