Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / javadoc / 2.38.0 / org / apache / beam / sdk / io / elasticsearch / ElasticsearchIO.html
blob: 76e2872ff8bc1bc47a793ef7d6905aece5c6ace4 [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 -->
<title>ElasticsearchIO (Apache Beam 2.38.0-SNAPSHOT)</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="ElasticsearchIO (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BoundedElasticsearchSource.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html" target="_top">Frames</a></li>
<li><a href="ElasticsearchIO.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><a href="#nested.class.summary">Nested</a>&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.beam.sdk.io.elasticsearch</div>
<h2 title="Class ElasticsearchIO" class="title">Class ElasticsearchIO</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.elasticsearch.ElasticsearchIO</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>)
public class <span class="typeNameLabel">ElasticsearchIO</span>
extends java.lang.Object</pre>
<div class="block">Transforms for reading and writing data from/to Elasticsearch.
<h3>Reading from Elasticsearch</h3>
<p><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#read--"><code>ElasticsearchIO.read()</code></a> returns a bounded <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection&lt;String&gt;</code></a> representing JSON documents.
<p>To configure the <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#read--"><code>read()</code></a>, you have to provide a connection configuration
containing the HTTP address of the instances, an index name and a type. The following example
illustrates options for configuring the source:
<pre><code>
pipeline.apply(ElasticsearchIO.read().withConnectionConfiguration(
ElasticsearchIO.ConnectionConfiguration.create("http://host:9200", "my-index", "my-type")
)
</code></pre>
<p>The connection configuration also accepts optional configuration: <code>withUsername()</code>,
<code>withPassword()</code>, <code>withApiKey()</code> and <code>withBearerToken()</code>.
<p>You can also specify a query on the <code>read()</code> using <code>withQuery()</code>.
<p>There are many more configuration options which can be found by looking at the with* methods
of <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Read.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.Read</code></a>
<h3>Writing to Elasticsearch</h3>
<p>To write documents to Elasticsearch, use <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#write--"><code>ElasticsearchIO.write()</code></a>, which writes JSON documents from a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection&lt;String&gt;</code></a> (which can be bounded or unbounded).
<p><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.Write</code></a> involves 2 discrete steps:
<ul>
<li>Converting the input PCollection of valid ES documents into Bulk API directives i.e. Should
the input document result in: update, insert, delete, with version, with routing, etc (See
<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.DocToBulk</code></a>)
<li>Batching Bulk API directives together and interfacing with an Elasticsearch cluster. (See
<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.BulkIO</code></a>)
</ul>
<p>In most cases, using <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#write--"><code>write()</code></a> will be desirable. In some cases, one may
want to use <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.DocToBulk</code></a> and <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.BulkIO</code></a> directly. Such
cases might include:
<ul>
<li>Unit testing. Ensure that output Bulk API entities for a given set of inputs will produce
an expected result, without the need for an available Elasticsearch cluster. See <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#docToBulk--"><code>docToBulk()</code></a>
<li>Flexible options for data backup. Serialized Bulk API entities can be forked and sent to
both Elasticsearch and a data lake.
<li>Mirroring data to multiple clusters. Presently, mirroring data to multiple clusters would
require duplicate computation.
<li>Better batching with input streams in one job. A job may produce multiple "shapes" of Bulk
API directives based on multiple input types, and then "fan-in" all serialized Bulk
directives into a single BulkIO transform to improve batching semantics.
<li>Decoupled jobs. Job(s) could be made to produce Bulk directives and then publish them to a
message bus. A distinct job could consume from that message bus and solely be responsible
for IO with the target cluster(s).
</ul>
<p>Note that configurations options for <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.Write</code></a> are a union of
configutation options for <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.DocToBulk</code></a> and <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.BulkIO</code></a>.
<p>To configure <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#write--"><code>ElasticsearchIO.write()</code></a>, similar to the read, you
have to provide a connection configuration. For instance:
<pre><code>
pipeline
.apply(...)
.apply(ElasticsearchIO.write().withConnectionConfiguration(
ElasticsearchIO.ConnectionConfiguration.create("http://host:9200", "my-index", "my-type")
)
</code></pre>
<p>There are many more configuration options which can be found by looking at the with* methods
of <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.Write</code></a></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BoundedElasticsearchSource.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.BoundedElasticsearchSource</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource</code></a> reading from Elasticsearch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.BulkIO</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> writing Bulk API entities created by <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><code>ElasticsearchIO.DocToBulk</code></a> to
an Elasticsearch cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.ConnectionConfiguration.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.ConnectionConfiguration</a></span></code>
<div class="block">A POJO describing a connection configuration to Elasticsearch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.DocToBulk</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> converting docs to their Bulk API counterparts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocumentCoder.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.DocumentCoder</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Read.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Read</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> reading data from Elasticsearch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.RetryConfiguration</a></span></code>
<div class="block">A POJO encapsulating a configuration for retry behavior when issuing requests to ES.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Write</a></span></code>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> writing data to Elasticsearch.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.BulkIO</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#bulkIO--">bulkIO</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.DocToBulk</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#docToBulk--">docToBulk</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Read.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Read</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#read--">read</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Write</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html#write--">write</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Read.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Read</a>&nbsp;read()</pre>
</li>
</ul>
<a name="docToBulk--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>docToBulk</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.DocToBulk</a>&nbsp;docToBulk()</pre>
</li>
</ul>
<a name="bulkIO--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bulkIO</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BulkIO.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.BulkIO</a>&nbsp;bulkIO()</pre>
</li>
</ul>
<a name="write--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>write</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Write</a>&nbsp;write()</pre>
</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="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>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.BoundedElasticsearchSource.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html" target="_top">Frames</a></li>
<li><a href="ElasticsearchIO.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><a href="#nested.class.summary">Nested</a>&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 ======= -->
</body>
</html>