kafka_neu-1778570057504.zip-extract/kafka-4.2.0-src/docs/apis/_index.md

Path
kafka_neu-1778570057504.zip-extract/kafka-4.2.0-src/docs/apis/_index.md
Status
scanned
Type
file
Name
_index.md
Extension
.md
Programming language

      
    
Mime type
text/plain
File type
exported SGML document, ASCII text, with very long lines
Tag

      
    
Rootfs path

      
    
Size
5759 (5.6 KB)
MD5
c450e9010813032bbaa487fe771e1db8
SHA1
db10aea722011815bc984a3b1eeb47da1a59c0a1
SHA256
fe7b196a7a3ffe5ce8ee1a3fbfcb022de03c1d5d7396345426609dc92f9d40a2
SHA512

      
    
SHA1_git
cbddb6414978367d7cfb34625c3764c858438b67
Is binary

      
    
Is text
True
Is archive

      
    
Is media

      
    
Is legal

      
    
Is manifest

      
    
Is readme

      
    
Is top level

      
    
Is key file

      
    
_index.md | 5.6 KB |

--- title: API description: weight: 2 tags: ['kafka', 'docs'] aliases: keywords: type: docs --- <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> Kafka includes six core apis: 1. The Producer API allows applications to send streams of data to topics in the Kafka cluster. 2. The Consumer API allows applications to read streams of data from topics in the Kafka cluster. 3. The Share consumer API allows applications in a share group to cooperatively consume and process data from Kafka topics. 4. The Streams API allows transforming streams of data from input topics to output topics. 5. The Connect API allows implementing connectors that continually pull from some source system or application into Kafka or push from Kafka into some sink system or application. 6. The Admin API allows managing and inspecting topics, brokers, and other Kafka objects. Kafka exposes all its functionality over a language-independent protocol which has clients available in many programming languages. However only the Java clients are maintained as part of the main Kafka project, the others are available as independent open source projects. A list of non-Java clients is available [here](https://cwiki.apache.org/confluence/x/3gDVAQ). # Producer API The Producer API allows applications to send streams of data to topics in the Kafka cluster. Examples of using the producer are shown in the [javadocs](/{version}/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html "Kafka 4.2 Javadoc"). To use the producer, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> <version>4.2.0</version> </dependency> # Consumer API The Consumer API allows applications to read streams of data from topics in the Kafka cluster. Examples of using the consumer are shown in the [javadocs](/{version}/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html "Kafka 4.2 Javadoc"). To use the consumer, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> <version>4.2.0</version> </dependency> # Share Consumer API The Share Consumer API enables applications in a share group to cooperatively consume and process data from Kafka topics. Examples of using the share consumer are shown in the [javadocs](/{version}/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaShareConsumer.html "Kafka 4.2 Javadoc"). To use the share consumer, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> <version>4.2.0</version> </dependency> # Streams API The [Streams](/42/documentation/streams) API allows transforming streams of data from input topics to output topics. Examples of using this library are shown in the [javadocs](/{version}/javadoc/index.html?org/apache/kafka/streams/KafkaStreams.html "Kafka 4.2 Javadoc"). Additional documentation on using the Streams API is available [here](/42/documentation/streams). To use Kafka Streams, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-streams</artifactId> <version>4.2.0</version> </dependency> When using Scala you may optionally include the `kafka-streams-scala` library. Additional documentation on using the Kafka Streams DSL for Scala is available [in the developer guide](/42/documentation/streams/developer-guide/dsl-api.html#scala-dsl). To use Kafka Streams DSL for Scala 2.13, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-streams-scala_2.13</artifactId> <version>4.2.0</version> </dependency> # Connect API The Connect API allows implementing connectors that continually pull from some source data system into Kafka or push from Kafka into some sink data system. Many users of Connect won't need to use this API directly, though, they can use pre-built connectors without needing to write any code. Additional information on using Connect is available [here](/documentation.html#connect). Those who want to implement custom connectors can see the [javadoc](/{version}/javadoc/index.html?org/apache/kafka/connect "Kafka 4.2 Javadoc"). # Admin API The Admin API supports managing and inspecting topics, brokers, acls, and other Kafka objects. To use the Admin API, add the following Maven dependency to your project: <dependency> <groupId>org.apache.kafka</groupId> <artifactId>kafka-clients</artifactId> <version>4.2.0</version> </dependency> For more information about the Admin APIs, see the [javadoc](/{version}/javadoc/index.html?org/apache/kafka/clients/admin/Admin.html "Kafka 4.2 Javadoc").
Detected license expression
apache-2.0
Detected license expression (SPDX)
Apache-2.0
Percentage of license text
14.3
Copyrights

      
    
Holders

      
    
Authors

      
    
License detections License expression License expression SPDX
apache_2_0-4bde3f57-78aa-4201-96bf-531cba09e7de apache-2.0 Apache-2.0
URL Start line End line
http://www.apache.org/licenses/LICENSE-2.0 19 19
https://cwiki.apache.org/confluence/x/3gDVAQ 37 37