| <!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.kafka (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="org.apache.beam.sdk.io.kafka (Apache Beam 2.38.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/jms/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kafka/serialization/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kafka/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <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 org.apache.beam.sdk.io.kafka</h1> |
| <div class="docSummary"> |
| <div class="block">Transforms for reading and writing from Apache Kafka.</div> |
| </div> |
| <p>See: <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"> </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/kafka/DeserializerProvider.html" title="interface in org.apache.beam.sdk.io.kafka">DeserializerProvider</a><T></td> |
| <td class="colLast"> |
| <div class="block">Provides a configured <a href="https://static.javadoc.io/org.apache.kafka/kafka-clients/2.4.1/org/apache/kafka/common/serialization/Deserializer.html?is-external=true" title="class or interface in org.apache.kafka.common.serialization"><code>Deserializer</code></a> instance and its associated <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaPublishTimestampFunction.html" title="interface in org.apache.beam.sdk.io.kafka">KafkaPublishTimestampFunction</a><T></td> |
| <td class="colLast"> |
| <div class="block">An interface for providing custom timestamp for elements written to Kafka.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kafka">TimestampPolicyFactory</a><KeyT,ValueT></td> |
| <td class="colLast"> |
| <div class="block">An extendable factory to create a <a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicy.html" title="class in org.apache.beam.sdk.io.kafka"><code>TimestampPolicy</code></a> for each partition at runtime by |
| KafkaIO reader.</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"> </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/kafka/ConfluentSchemaRegistryDeserializerProvider.html" title="class in org.apache.beam.sdk.io.kafka">ConfluentSchemaRegistryDeserializerProvider</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/io/kafka/DeserializerProvider.html" title="interface in org.apache.beam.sdk.io.kafka"><code>DeserializerProvider</code></a> that uses <a |
| href="https://github.com/confluentinc/schema-registry">Confluent Schema Registry</a> to resolve a |
| <a href="https://static.javadoc.io/org.apache.kafka/kafka-clients/2.4.1/org/apache/kafka/common/serialization/Deserializer.html?is-external=true" title="class or interface in org.apache.kafka.common.serialization"><code>Deserializer</code></a>s and <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> given a subject.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/CustomTimestampPolicyWithLimitedDelay.html" title="class in org.apache.beam.sdk.io.kafka">CustomTimestampPolicyWithLimitedDelay</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A policy for custom record timestamps where timestamps within a partition are expected to be |
| roughly monotonically increasing with a cap on out of order event delays (say 1 minute).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaCheckpointMark.html" title="class in org.apache.beam.sdk.io.kafka">KafkaCheckpointMark</a></td> |
| <td class="colLast"> |
| <div class="block">Checkpoint for a <code>KafkaUnboundedReader</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaCheckpointMark.PartitionMark.html" title="class in org.apache.beam.sdk.io.kafka">KafkaCheckpointMark.PartitionMark</a></td> |
| <td class="colLast"> |
| <div class="block">A tuple to hold topic, partition, and offset that comprise the checkpoint for a single |
| partition.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaCommitOffset.html" title="class in org.apache.beam.sdk.io.kafka">KafkaCommitOffset</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that commits offsets of <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaRecord.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO</a></td> |
| <td class="colLast"> |
| <div class="block">An unbounded source and a sink for <a href="http://kafka.apache.org/">Kafka</a> topics.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Read.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Read</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read from Kafka topics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Read.External.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Read.External</a></td> |
| <td class="colLast"> |
| <div class="block">Exposes <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaIO.TypedWithoutMetadata</code></a> as an external transform for cross-language |
| usage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Read.External.Configuration.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Read.External.Configuration</a></td> |
| <td class="colLast"> |
| <div class="block">Parameters class to expose the Read transform to an external SDK.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.ReadSourceDescriptors.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.ReadSourceDescriptors</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read from <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaSourceDescriptor.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaSourceDescriptor</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.TypedWithoutMetadata.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.TypedWithoutMetadata</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read from Kafka topics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Write.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Write</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write to a Kafka topic with KVs .</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Write.External.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Write.External</a></td> |
| <td class="colLast"> |
| <div class="block">Exposes <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Write.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaIO.Write</code></a> as an external transform for cross-language usage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.Write.External.Configuration.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.Write.External.Configuration</a></td> |
| <td class="colLast"> |
| <div class="block">Parameters class to expose the Write transform to an external SDK.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaIO.WriteRecords.html" title="class in org.apache.beam.sdk.io.kafka">KafkaIO.WriteRecords</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write to a Kafka topic with ProducerRecord's.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaRecord.html" title="class in org.apache.beam.sdk.io.kafka">KafkaRecord</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">KafkaRecord contains key and value of the record as well as metadata for the record (topic name, |
| partition id, and offset).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaRecordCoder.html" title="class in org.apache.beam.sdk.io.kafka">KafkaRecordCoder</a><K,V></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaRecord.html" title="class in org.apache.beam.sdk.io.kafka"><code>KafkaRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaSourceDescriptor.html" title="class in org.apache.beam.sdk.io.kafka">KafkaSourceDescriptor</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a Kafka source description.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/ProducerRecordCoder.html" title="class in org.apache.beam.sdk.io.kafka">ProducerRecordCoder</a><K,V></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="https://static.javadoc.io/org.apache.kafka/kafka-clients/2.4.1/org/apache/kafka/clients/producer/ProducerRecord.html?is-external=true" title="class or interface in org.apache.kafka.clients.producer"><code>ProducerRecord</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicy.html" title="class in org.apache.beam.sdk.io.kafka">TimestampPolicy</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A timestamp policy to assign event time for messages in a Kafka partition and watermark for it.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicy.PartitionContext.html" title="class in org.apache.beam.sdk.io.kafka">TimestampPolicy.PartitionContext</a></td> |
| <td class="colLast"> |
| <div class="block">The context contains state maintained in the reader for the partition.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicyFactory.LogAppendTimePolicy.html" title="class in org.apache.beam.sdk.io.kafka">TimestampPolicyFactory.LogAppendTimePolicy</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">Assigns Kafka's log append time (server side ingestion time) to each record.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicyFactory.ProcessingTimePolicy.html" title="class in org.apache.beam.sdk.io.kafka">TimestampPolicyFactory.ProcessingTimePolicy</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">A simple policy that uses current time for event time and watermark.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TimestampPolicyFactory.TimestampFnPolicy.html" title="class in org.apache.beam.sdk.io.kafka">TimestampPolicyFactory.TimestampFnPolicy</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">Internal policy to support deprecated withTimestampFn API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/TopicPartitionCoder.html" title="class in org.apache.beam.sdk.io.kafka">TopicPartitionCoder</a></td> |
| <td class="colLast"> |
| <div class="block">The <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for encoding and decoding <a href="https://static.javadoc.io/org.apache.kafka/kafka-clients/2.4.1/org/apache/kafka/common/TopicPartition.html?is-external=true" title="class or interface in org.apache.kafka.common"><code>TopicPartition</code></a> in Beam.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kafka/KafkaTimestampType.html" title="enum in org.apache.beam.sdk.io.kafka">KafkaTimestampType</a></td> |
| <td class="colLast"> |
| <div class="block">This is a copy of Kafka's <a href="https://static.javadoc.io/org.apache.kafka/kafka-clients/2.4.1/org/apache/kafka/common/record.TimestampType.html?is-external=true" title="class or interface in org.apache.kafka.common"><code>TimestampType</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.io.kafka Description">Package org.apache.beam.sdk.io.kafka Description</h2> |
| <div class="block">Transforms for reading and writing from Apache Kafka.</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/jms/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kafka/serialization/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kafka/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |