github.com/apache/beam/sdks/v2@v2.48.2/java/io/kafka/README.md (about)

     1  <!--
     2      Licensed to the Apache Software Foundation (ASF) under one
     3      or more contributor license agreements.  See the NOTICE file
     4      distributed with this work for additional information
     5      regarding copyright ownership.  The ASF licenses this file
     6      to you under the Apache License, Version 2.0 (the
     7      "License"); you may not use this file except in compliance
     8      with the License.  You may obtain a copy of the License at
     9  
    10        http://www.apache.org/licenses/LICENSE-2.0
    11  
    12      Unless required by applicable law or agreed to in writing,
    13      software distributed under the License is distributed on an
    14      "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15      KIND, either express or implied.  See the License for the
    16      specific language governing permissions and limitations
    17      under the License.
    18  -->
    19  
    20  KafkaIO contains I/O transforms which allow you to read/write messages from/to [Apache Kafka](http://kafka.apache.org/).
    21  
    22  ## Dependencies
    23  
    24  To use KafkaIO you must first add a dependency on `beam-sdks-java-io-kafka`. KafkaIO supports
    25  multiple versions of Kafka clients at run time. It does not pull a specific version `kafka-clients`
    26  transitively. You need to include a compatible version of `kafka-clients` as runtime dependency.
    27  Usually current and recent versions of Kafka are supported, please see JavaDoc for KafkaIO for
    28  complete list.
    29  
    30  ```maven
    31  <dependency>
    32      <groupId>org.apache.beam</groupId>
    33      <artifactId>beam-sdks-java-io-kafka</artifactId>
    34      <version>...</version>
    35  </dependency>
    36  
    37  <dependency>
    38    <groupId>org.apache.kafka</groupId>
    39    <artifactId>kafka-clients</artifactId>
    40    <version>a_recent_version</version>
    41    <scope>runtime</scope>
    42  </dependency>
    43  ```
    44  
    45  ## Documentation
    46  
    47  The documentation is maintained in JavaDoc for KafkaIO class. It includes
    48   usage examples and primary concepts.
    49  - [KafkaIO.java](src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java)