| <!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>FirestoreV1 (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="FirestoreV1 (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/gcp/firestore/FirestoreOptions.html" title="interface in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchGetDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html" target="_top">Frames</a></li> |
| <li><a href="FirestoreV1.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.gcp.firestore</div> |
| <h2 title="Class FirestoreV1" class="title">Class FirestoreV1</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.gcp.firestore.FirestoreV1</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/concurrent/Immutable.html?is-external=true" title="class or interface in javax.annotation.concurrent">@Immutable</a> |
| public final class <span class="typeNameLabel">FirestoreV1</span> |
| extends java.lang.Object</pre> |
| <div class="block"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1</code></a> provides an API which provides lifecycle managed <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>s for <a |
| target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1">Cloud Firestore |
| v1 API</a>. |
| |
| <p>This class is part of the Firestore Connector DSL and should be accessed via <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a>. |
| |
| <p>All <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>s provided by this API use <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options"><code>GcpOptions</code></a> on <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> for credentials access and projectId |
| resolution. As such, the lifecycle of gRPC clients and project information is scoped to the |
| bundle level, not the worker level. |
| |
| <p> |
| |
| <h3>Operations</h3> |
| |
| <h4>Read</h4> |
| |
| <p>The currently supported read operations and their execution behavior are as follows: |
| |
| <table> |
| <tbody> |
| <tr> |
| <th>RPC</th> |
| <th>Execution Behavior</th> |
| <th>Example Usage</th> |
| </tr> |
| <tr> |
| <td><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.PartitionQuery.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.PartitionQuery</code></a></td> |
| <td>Parallel Streaming</td> |
| <td> |
| <pre> |
| PCollection<<code>PartitionQueryRequest</code>> partitionQueryRequests = ...; |
| PCollection<<code>RunQueryRequest</code>> runQueryRequests = partitionQueryRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#partitionQuery--"><code>partitionQuery()</code></a>.build()); |
| PCollection<<code>RunQueryResponse</code>> runQueryResponses = runQueryRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#runQuery--"><code>runQuery()</code></a>.build()); |
| </pre> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.RunQuery.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.RunQuery</code></a></td> |
| <td>Sequential Streaming</td> |
| <td> |
| <pre> |
| PCollection<<code>RunQueryRequest</code>> runQueryRequests = ...; |
| PCollection<<code>RunQueryResponse</code>> runQueryResponses = runQueryRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#runQuery--"><code>runQuery()</code></a>.build()); |
| </pre> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchGetDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.BatchGetDocuments</code></a></td> |
| <td>Sequential Streaming</td> |
| <td> |
| <pre> |
| PCollection<<code>BatchGetDocumentsRequest</code>> batchGetDocumentsRequests = ...; |
| PCollection<<code>BatchGetDocumentsResponse</code>> batchGetDocumentsResponses = batchGetDocumentsRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#batchGetDocuments--"><code>batchGetDocuments()</code></a>.build()); |
| </pre> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListCollectionIds.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.ListCollectionIds</code></a></td> |
| <td>Sequential Paginated</td> |
| <td> |
| <pre> |
| PCollection<<code>ListCollectionIdsRequest</code>> listCollectionIdsRequests = ...; |
| PCollection<<code>ListCollectionIdsResponse</code>> listCollectionIdsResponses = listCollectionIdsRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#listCollectionIds--"><code>listCollectionIds()</code></a>.build()); |
| </pre> |
| </td> |
| </tr> |
| <tr> |
| <td><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.ListDocuments</code></a></td> |
| <td>Sequential Paginated</td> |
| <td> |
| <pre> |
| PCollection<<code>ListDocumentsRequest</code>> listDocumentsRequests = ...; |
| PCollection<<code>ListDocumentsResponse</code>> listDocumentsResponses = listDocumentsRequests |
| .apply(FirestoreIO.v1().read().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html#listDocuments--"><code>listDocuments()</code></a>.build()); |
| </pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p>PartitionQuery should be preferred over other options if at all possible, becuase it has the |
| ability to parallelize execution of multiple queries for specific sub-ranges of the full results. |
| When choosing the value to set for <code>PartitionQueryRequest.Builder#setPartitionCount(long)</code>, |
| ensure you are picking a value this makes sense for your data set and your max number of workers. |
| <i>If you find that a partition query is taking a unexpectedly long time, try increasing the |
| number of partitions.</i> Depending on how large your dataset is increasing as much as 10x can |
| significantly reduce total partition query wall time. |
| |
| <p>You should only ever use ListDocuments if the use of <a target="_blank" rel="noopener |
| noreferrer" |
| href="https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.ListDocumentsRequest"><code>show_missing</code></a> is needed to access a document. RunQuery and PartitionQuery will always be |
| faster if the use of <code>show_missing</code> is not needed. |
| |
| <h4>Write</h4> |
| |
| To write a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> to Cloud Firestore use <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html#write--"><code>write()</code></a>, picking the |
| behavior of the writer. |
| |
| <p>Writes use Cloud Firestore's BatchWrite api which provides fine grained write semantics. |
| |
| <p>The default behavior is to fail a bundle if any single write fails with a non-retryable error. |
| |
| <pre> |
| PCollection<<code>Write</code>> writes = ...; |
| PCollection<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.WriteSuccessSummary.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.WriteSuccessSummary</code></a>> sink = writes |
| .apply(FirestoreIO.v1().write().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Write.html#batchWrite--"><code>batchWrite()</code></a>.build()); |
| </pre> |
| |
| Alternatively, if you'd rather output write failures to a Dead Letter Queue add <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithSummary.Builder.html#withDeadLetterQueue--"><code>withDeadLetterQueue</code></a> when building your |
| writer. |
| |
| <pre> |
| PCollection<<code>Write</code>> writes = ...; |
| PCollection<<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.WriteFailure.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.WriteFailure</code></a>> writeFailures = writes |
| .apply(FirestoreIO.v1().write().<a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Write.html#batchWrite--"><code>batchWrite()</code></a>.withDeadLetterQueue().build()); |
| </pre> |
| |
| <h3>Permissions</h3> |
| |
| Permission requirements depend on the <code>PipelineRunner</code> that is used to execute the |
| pipeline. Please refer to the documentation of corresponding <code>PipelineRunner</code>s for more |
| details. |
| |
| <p>Please see <a target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/firestore/docs/security/iam#roles">Security for server client |
| libraries > Roles </a>for security and permission related information specific to Cloud |
| Firestore. |
| |
| <p>Optionally, Cloud Firestore V1 Emulator, running locally, could be used for testing purposes |
| by providing the host port information via <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreOptions.html#setEmulatorHost-java.lang.String-"><code>FirestoreOptions.setEmulatorHost(String)</code></a>. In |
| such a case, all the Cloud Firestore API calls are directed to the Emulator.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a>, |
| <a href="../../../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>, |
| <a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>, |
| <a href="../../../../../../../org/apache/beam/sdk/extensions/gcp/options/GcpOptions.html" title="interface in org.apache.beam.sdk.extensions.gcp.options"><code>GcpOptions</code></a>, |
| <a target="_blank" rel="noopener noreferrer" |
| href="https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1">Cloud |
| Firestore v1 API</a></dd> |
| </dl> |
| </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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchGetDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchGetDocuments</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>BatchGetDocumentsRequest</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><code>BatchGetDocumentsResponse</code><code>>></code> which will read from Firestore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithDeadLetterQueue.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchWriteWithDeadLetterQueue</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>Write</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.WriteFailure.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.WriteFailure</code></a><code>></code> which will write to Firestore.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithSummary.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchWriteWithSummary</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>Write</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values"><code>PDone</code></a><code>></code> which will write to Firestore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.FailedWritesException.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.FailedWritesException</a></span></code> |
| <div class="block">Exception that is thrown if one or more <code>Write</code>s is unsuccessful |
| with a non-retryable status code.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListCollectionIds.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.ListCollectionIds</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>ListCollectionIdsRequest</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><code>ListCollectionIdsResponse</code><code>>></code> which will read from Firestore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.ListDocuments</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>ListDocumentsRequest</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><code>ListDocumentsResponse</code><code>>></code> which will read from Firestore.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.PartitionQuery.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.PartitionQuery</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>PartitionQueryRequest</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><code>RunQueryRequest</code><code>>></code> |
| which will read from Firestore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Read</a></span></code> |
| <div class="block">Type safe builder factory for read operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.RunQuery.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.RunQuery</a></span></code> |
| <div class="block">Concrete class representing a <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code><</code><code>RunQueryRequest</code><code>>, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code><</code><code>RunQueryResponse</code><code>>></code> which |
| will read from Firestore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Write.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Write</a></span></code> |
| <div class="block">Type safe builder factory for write operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.WriteFailure.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.WriteFailure</a></span></code> |
| <div class="block">Failure details for an attempted <code>Write</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.WriteSuccessSummary.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.WriteSuccessSummary</a></span></code> |
| <div class="block">Summary object produced when a number of writes are successfully written to Firestore in a |
| single BatchWrite.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html#read--">read</a></span>()</code> |
| <div class="block">The class returned by this method provides the ability to create <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> |
| for read operations available in the Firestore V1 API provided by <code>FirestoreStub</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Write.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html#write--">write</a></span>()</code> |
| <div class="block">The class returned by this method provides the ability to create <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> |
| for write operations available in the Firestore V1 API provided by <code>FirestoreStub</code>.</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"> |
| <!-- ============ 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 <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Read.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Read</a> read()</pre> |
| <div class="block">The class returned by this method provides the ability to create <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> |
| for read operations available in the Firestore V1 API provided by <code>FirestoreStub</code>. |
| |
| <p>This method is part of the Firestore Connector DSL and should be accessed via <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a>. |
| |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Type safe builder factory for read operations.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.Write.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.Write</a> write()</pre> |
| <div class="block">The class returned by this method provides the ability to create <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a> |
| for write operations available in the Firestore V1 API provided by <code>FirestoreStub</code>. |
| |
| <p>This method is part of the Firestore Connector DSL and should be accessed via <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a>. |
| |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Type safe builder factory for write operations.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html#v1--"><code>FirestoreIO.v1()</code></a></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/gcp/firestore/FirestoreOptions.html" title="interface in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchGetDocuments.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html" target="_top">Frames</a></li> |
| <li><a href="FirestoreV1.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
