Metadata-Version: 2.4
Name: ionoscloud_kafka
Version: 1.0.0b1
Summary: Event Streams for Apache Kafka API
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,Event Streams for Apache Kafka API
Author: IONOS Cloud Support
Author-email: support@cloud.ionos.com
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
Project-URL: Repository, https://github.com/ionos-cloud/sdk-python
Description-Content-Type: text/markdown

# ionoscloud-kafka
A managed Apache Kafka cluster is designed to be highly fault-tolerant and scalable,
allowing large volumes of data to be ingested, stored, and processed in real-time. By
distributing data across multiple brokers, Kafka achieves high throughput and low
latency, making it suitable for applications requiring real-time data processing and
analytics.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.8.0
- Package version: 1.0.0-beta.1
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://docs.ionos.com/support/general-information/contact-information](https://docs.ionos.com/support/general-information/contact-information)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/ionos-cloud/sdk-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python.git`)

Then import the package:
```python
import ionoscloud_kafka
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ionoscloud_kafka
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ionoscloud_kafka
from ionoscloud_kafka.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://kafka.de-fra.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_kafka.Configuration(
    host = "https://kafka.de-fra.ionos.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_kafka.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# Enter a context with an instance of the API client
with ionoscloud_kafka.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_kafka.ClustersApi(api_client)
    cluster_id = 'e69b22a5-8fee-56b1-b6fb-4a07e4205ead' # str | The ID (UUID) of the Cluster.

    try:
        # Delete Cluster
        api_instance.clusters_delete(cluster_id)
    except ApiException as e:
        print("Exception when calling ClustersApi->clusters_delete: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://kafka.de-fra.ionos.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClustersApi* | [**clusters_delete**](docs/api/ClustersApi.md#clusters_delete) | **DELETE** /clusters/{clusterId} | Delete Cluster
*ClustersApi* | [**clusters_find_by_id**](docs/api/ClustersApi.md#clusters_find_by_id) | **GET** /clusters/{clusterId} | Retrieve Cluster
*ClustersApi* | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | Retrieve all Clusters
*ClustersApi* | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create Cluster
*TopicsApi* | [**clusters_topics_delete**](docs/api/TopicsApi.md#clusters_topics_delete) | **DELETE** /clusters/{clusterId}/topics/{topicId} | Delete Topic
*TopicsApi* | [**clusters_topics_find_by_id**](docs/api/TopicsApi.md#clusters_topics_find_by_id) | **GET** /clusters/{clusterId}/topics/{topicId} | Retrieve Topic
*TopicsApi* | [**clusters_topics_get**](docs/api/TopicsApi.md#clusters_topics_get) | **GET** /clusters/{clusterId}/topics | Retrieve all Topics
*TopicsApi* | [**clusters_topics_post**](docs/api/TopicsApi.md#clusters_topics_post) | **POST** /clusters/{clusterId}/topics | Create Topic
*UsersApi* | [**clusters_users_access_get**](docs/api/UsersApi.md#clusters_users_access_get) | **GET** /clusters/{clusterId}/users/{userId}/access | Retrieve Apache Kafka User with Credentials
*UsersApi* | [**clusters_users_get**](docs/api/UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Retrieve all Users


## Documentation For Models

 - [Cluster](docs/models/Cluster.md)
 - [ClusterCreate](docs/models/ClusterCreate.md)
 - [ClusterMetadata](docs/models/ClusterMetadata.md)
 - [ClusterRead](docs/models/ClusterRead.md)
 - [ClusterReadList](docs/models/ClusterReadList.md)
 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [KafkaClusterConnection](docs/models/KafkaClusterConnection.md)
 - [Links](docs/models/Links.md)
 - [Metadata](docs/models/Metadata.md)
 - [Pagination](docs/models/Pagination.md)
 - [ResourceMetadata](docs/models/ResourceMetadata.md)
 - [ResourceState](docs/models/ResourceState.md)
 - [Topic](docs/models/Topic.md)
 - [TopicCreate](docs/models/TopicCreate.md)
 - [TopicLogRetention](docs/models/TopicLogRetention.md)
 - [TopicRead](docs/models/TopicRead.md)
 - [TopicReadList](docs/models/TopicReadList.md)
 - [User](docs/models/User.md)
 - [UserAccessMetadata](docs/models/UserAccessMetadata.md)
 - [UserRead](docs/models/UserRead.md)
 - [UserReadAccess](docs/models/UserReadAccess.md)
 - [UserReadList](docs/models/UserReadList.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="tokenAuth"></a>
### tokenAuth

- **Type**: Bearer authentication (JWT)


## Author

support@cloud.ionos.com



