| <!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.Document (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.Document (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocumentCoder.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" target="_top">Frames</a></li> |
| <li><a href="ElasticsearchIO.Document.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.Document" class="title">Class ElasticsearchIO.Document</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.Document</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/coders/DefaultCoder.html" title="annotation in org.apache.beam.sdk.coders">@DefaultCoder</a>(<a href="../../../../../../org/apache/beam/sdk/coders/DefaultCoder.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocumentCoder.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.DocumentCoder.class</a>) |
| public abstract static class <span class="typeNameLabel">ElasticsearchIO.Document</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.elasticsearch.ElasticsearchIO.Document">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#Document--">Document</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#create--">create</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#getBulkDirective--">getBulkDirective</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#getHasError--">getHasError</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#getInputDoc--">getInputDoc</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#getResponseItemJson--">getResponseItemJson</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#getTimestamp--">getTimestamp</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#withBulkDirective-java.lang.String-">withBulkDirective</a></span>(java.lang.String bulkDirective)</code> |
| <div class="block">Sets the bulk directive representation of an input document.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#withHasError-boolean-">withHasError</a></span>(boolean hasError)</code> |
| <div class="block">Used to set whether or not there was an error for a given document as indicated by the |
| response from Elasticsearch.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#withInputDoc-java.lang.String-">withInputDoc</a></span>(java.lang.String inputDoc)</code> |
| <div class="block">Sets the input document i.e.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#withResponseItemJson-java.lang.String-">withResponseItemJson</a></span>(java.lang.String responseItemJson)</code> |
| <div class="block">Sets the element from Elasticsearch Bulk API response "items" pertaining to this |
| WriteSummary.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html#withTimestamp-org.joda.time.Instant-">withTimestamp</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp)</code> |
| <div class="block">Sets the timestamp of the element in the PCollection, to be used in order to output |
| WriteSummary to the same window from which the inputDoc originated.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Document--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Document</h4> |
| <pre>public Document()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getInputDoc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputDoc</h4> |
| <pre>public abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String getInputDoc()</pre> |
| </li> |
| </ul> |
| <a name="getBulkDirective--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBulkDirective</h4> |
| <pre>public abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String getBulkDirective()</pre> |
| </li> |
| </ul> |
| <a name="getHasError--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHasError</h4> |
| <pre>public abstract java.lang.Boolean getHasError()</pre> |
| </li> |
| </ul> |
| <a name="getResponseItemJson--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseItemJson</h4> |
| <pre>public abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.String getResponseItemJson()</pre> |
| </li> |
| </ul> |
| <a name="getTimestamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimestamp</h4> |
| <pre>public abstract <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> getTimestamp()</pre> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> create()</pre> |
| </li> |
| </ul> |
| <a name="withInputDoc-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withInputDoc</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> withInputDoc(java.lang.String inputDoc)</pre> |
| <div class="block">Sets the input document i.e. desired document that will end up in Elasticsearch for this |
| WriteSummary object. The inputDoc will be the a document that was part of the input |
| PCollection to either <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> or <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></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inputDoc</code> - Serialized json input document destined to end up in Elasticsearch.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteSummary with inputDocument set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBulkDirective-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBulkDirective</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> withBulkDirective(java.lang.String bulkDirective)</pre> |
| <div class="block">Sets the bulk directive representation of an input document. This will be new-line separated |
| JSON where each line is valid JSON. Typically the first line includes meta-data and |
| instructions to Elasticsearch such as whether to overwrite a document, delete it, etc. and |
| the second line (if present) will be the document itself. For more info please see |
| https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bulkDirective</code> - Serialized new-line delimited json bulk API information.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteSummary with bulkDirective set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withResponseItemJson-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withResponseItemJson</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> withResponseItemJson(java.lang.String responseItemJson)</pre> |
| <div class="block">Sets the element from Elasticsearch Bulk API response "items" pertaining to this |
| WriteSummary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responseItemJson</code> - The Elasticsearch Bulk API response.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteSummary with Elasticsearch Bulk API response set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withHasError-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withHasError</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> withHasError(boolean hasError)</pre> |
| <div class="block">Used to set whether or not there was an error for a given document as indicated by the |
| response from Elasticsearch. Note that if using <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Write.html#withAllowableResponseErrors-java.util.Set-"><code>ElasticsearchIO.Write.withAllowableResponseErrors(java.util.Set<java.lang.String>)</code></a> |
| errors which are allowed will have a false value for hasError for their respective |
| WriteSummary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hasError</code> - Whether or not Elasticsearch returned an error when persisting a bulk |
| directive.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteSummary with hasError set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTimestamp-org.joda.time.Instant-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>withTimestamp</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" title="class in org.apache.beam.sdk.io.elasticsearch">ElasticsearchIO.Document</a> withTimestamp(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp)</pre> |
| <div class="block">Sets the timestamp of the element in the PCollection, to be used in order to output |
| WriteSummary to the same window from which the inputDoc originated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestamp</code> - The timestamp with which the WriteSummary will be output.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WriteSummary with timestamp set.</dd> |
| </dl> |
| </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><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocToBulk.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.DocumentCoder.html" title="class in org.apache.beam.sdk.io.elasticsearch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.Document.html" target="_top">Frames</a></li> |
| <li><a href="ElasticsearchIO.Document.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
