blob: c321c390f19201a6fedc23d126f3e9f6ce11b8d0 [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>org.apache.beam.sdk.io.gcp.firestore (Apache Beam 2.47.0)</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="org.apache.beam.sdk.io.gcp.firestore (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/datastore/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/healthcare/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p><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>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.gcp.firestore</h1>
<div class="docSummary">
<div class="block">Provides an API for reading from and writing to <a
href="https://cloud.google.com/firestore/docs">Google Cloud Firestore</a>.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreOptions.html" title="interface in org.apache.beam.sdk.io.gcp.firestore">FirestoreOptions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreIO</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreIO.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreIO</code></a> provides an API for reading from and writing to <a target="_blank"
rel="noopener noreferrer" href="https://cloud.google.com/firestore/docs">Google Cloud
Firestore</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1</a></td>
<td class="colLast">
<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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>BatchGetDocumentsRequest</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code>&lt;</code><code>BatchGetDocumentsResponse</code><code>&gt;&gt;</code> which will read from Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchGetDocuments.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchGetDocuments.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <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> allowing configuration and instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>Write</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</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>&gt;</code> which will write to Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithDeadLetterQueue.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchWriteWithDeadLetterQueue.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithDeadLetterQueue.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.BatchWriteWithDeadLetterQueue</code></a> allowing configuration and
instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>Write</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values"><code>PDone</code></a><code>&gt;</code> which will write to Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithSummary.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.BatchWriteWithSummary.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.BatchWriteWithSummary.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>FirestoreV1.BatchWriteWithSummary</code></a> allowing configuration and
instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>ListCollectionIdsRequest</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code>&lt;</code><code>ListCollectionIdsResponse</code><code>&gt;&gt;</code> which will read from Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListCollectionIds.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.ListCollectionIds.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <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> allowing configuration and instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>ListDocumentsRequest</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code>&lt;</code><code>ListDocumentsResponse</code><code>&gt;&gt;</code> which will read from Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.ListDocuments.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.ListDocuments.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <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> allowing configuration and instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>PartitionQueryRequest</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code>&lt;</code><code>RunQueryRequest</code><code>&gt;&gt;</code>
which will read from Firestore.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.PartitionQuery.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.PartitionQuery.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <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> allowing configuration and instantiation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Type safe builder factory for read operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>&lt;</code><a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a><code>&lt;</code><code>RunQueryRequest</code><code>&gt;, </code><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a><code>&lt;</code><code>RunQueryResponse</code><code>&gt;&gt;</code> which
will read from Firestore.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/FirestoreV1.RunQuery.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">FirestoreV1.RunQuery.Builder</a></td>
<td class="colLast">
<div class="block">A type safe builder for <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> allowing configuration and instantiation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Type safe builder factory for write operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Failure details for an attempted <code>Write</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Summary object produced when a number of writes are successfully written to Firestore in a
single BatchWrite.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions</a></td>
<td class="colLast">
<div class="block">Quality of Service manager options for Firestore RPCs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.Builder.html" title="class in org.apache.beam.sdk.io.gcp.firestore">RpcQosOptions.Builder</a></td>
<td class="colLast">
<div class="block">Mutable Builder class for creating instances of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/firestore/RpcQosOptions.html" title="class in org.apache.beam.sdk.io.gcp.firestore"><code>RpcQosOptions</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.gcp.firestore Description">Package org.apache.beam.sdk.io.gcp.firestore Description</h2>
<div class="block">Provides an API for reading from and writing to <a
href="https://cloud.google.com/firestore/docs">Google Cloud Firestore</a>.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/datastore/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/io/gcp/healthcare/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/firestore/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>