Google Git
Sign in
apache / beam-site / 2124d9d3064f7803e25018ca63200f5af5857a1f / . / javadoc / 2.8.0 / org / apache / beam / sdk / io / gcp / pubsub / package-summary.html
blob: 56e98b29c4caa9dfddad8b2efe285fdd4e67894e [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 (1.8.0_161-google-v7) on Thu Oct 18 16:14:37 PDT 2018 -->
<title>org.apache.beam.sdk.io.gcp.pubsub (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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.pubsub (Apache Beam 2.8.0-SNAPSHOT)";
}
}
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/spanner/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/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">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.gcp.pubsub</h1>
<div class="docSummary">
<div class="block">Defines transforms for reading and writing from <a href="https://cloud.google.com/pubsub/">Google
Cloud Pub/Sub</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/pubsub/PubsubClient.PubsubClientFactory.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.PubsubClientFactory</a></td>
<td class="colLast">
<div class="block">Factory for creating clients.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubOptions.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">PubsubOptions</a></td>
<td class="colLast">
<div class="block">Properties that can be set when using Google Cloud Pub/Sub with the Apache Beam SDK.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsubOptions.html" title="interface in org.apache.beam.sdk.io.gcp.pubsub">TestPubsubOptions</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> for <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsub.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>TestPubsub</code></a>.</div>
</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/pubsub/PubsubClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient</a></td>
<td class="colLast">
<div class="block">An (abstract) helper class for talking to Pubsub via an underlying transport.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.OutgoingMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.OutgoingMessage</a></td>
<td class="colLast">
<div class="block">A message to be sent to Pubsub.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.ProjectPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.ProjectPath</a></td>
<td class="colLast">
<div class="block">Path representing a cloud project id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.SubscriptionPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.SubscriptionPath</a></td>
<td class="colLast">
<div class="block">Path representing a Pubsub subscription.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubClient.TopicPath.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubClient.TopicPath</a></td>
<td class="colLast">
<div class="block">Path representing a Pubsub topic.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubCoderProviderRegistrar.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubCoderProviderRegistrar</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../../org/apache/beam/sdk/coders/CoderProviderRegistrar.html" title="interface in org.apache.beam.sdk.coders"><code>CoderProviderRegistrar</code></a> for standard types used with <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubIO</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubGrpcClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubGrpcClient</a></td>
<td class="colLast">
<div class="block">A helper class for talking to Pubsub via grpc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO</a></td>
<td class="colLast">
<div class="block">Read and Write <a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>s for Cloud Pub/Sub streams.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.PubsubSubscription.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO.PubsubSubscription</a></td>
<td class="colLast">
<div class="block">Class representing a Cloud Pub/Sub Subscription.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.PubsubTopic.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO.PubsubTopic</a></td>
<td class="colLast">
<div class="block">Class representing a Cloud Pub/Sub Topic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.Read.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO.Read</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html#read--"><code>PubsubIO.read()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.Write.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubIO.Write</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html#write--"><code>PubsubIO.write()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubJsonClient.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubJsonClient</a></td>
<td class="colLast">
<div class="block">A Pubsub client using JSON transport.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubMessage.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubMessage</a></td>
<td class="colLast">
<div class="block">Class representing a Pub/Sub message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubMessagePayloadOnlyCoder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubMessagePayloadOnlyCoder</a></td>
<td class="colLast">
<div class="block">A coder for PubsubMessage treating the raw bytes being decoded as the message's payload.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubMessageWithAttributesCoder.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubMessageWithAttributesCoder</a></td>
<td class="colLast">
<div class="block">A coder for PubsubMessage including attributes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubUnboundedSink.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubUnboundedSink</a></td>
<td class="colLast">
<div class="block">A PTransform which streams messages to Pubsub.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubUnboundedSource.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubUnboundedSource</a></td>
<td class="colLast">
<div class="block">Users should use <a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html#read--"><code>PubsubIO.read()</code></a> instead.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsub.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">TestPubsub</a></td>
<td class="colLast">
<div class="block">Test rule which creates a new topic with randomized name and exposes the APIs to work with it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/TestPubsubSignal.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">TestPubsubSignal</a></td>
<td class="colLast">
<div class="block">Test rule which observes elements of the <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> and checks whether they match the
success criteria.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.gcp.pubsub Description">Package org.apache.beam.sdk.io.gcp.pubsub Description</h2>
<div class="block">Defines transforms for reading and writing from <a href="https://cloud.google.com/pubsub/">Google
Cloud Pub/Sub</a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubIO.html" title="class in org.apache.beam.sdk.io.gcp.pubsub"><code>PubsubIO</code></a></dd>
</dl>
</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/spanner/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/io/gcp/pubsub/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>