Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 project:

Requirements.

Python 3.9+

Installation & Usage

pip install

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

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:

import ionoscloud_kafka

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ionoscloud_kafka

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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 DELETE /clusters/{clusterId} Delete Cluster
ClustersApi clusters_find_by_id GET /clusters/{clusterId} Retrieve Cluster
ClustersApi clusters_get GET /clusters Retrieve all Clusters
ClustersApi clusters_post POST /clusters Create Cluster
TopicsApi clusters_topics_delete DELETE /clusters/{clusterId}/topics/{topicId} Delete Topic
TopicsApi clusters_topics_find_by_id GET /clusters/{clusterId}/topics/{topicId} Retrieve Topic
TopicsApi clusters_topics_get GET /clusters/{clusterId}/topics Retrieve all Topics
TopicsApi clusters_topics_post POST /clusters/{clusterId}/topics Create Topic
UsersApi clusters_users_access_get GET /clusters/{clusterId}/users/{userId}/access Retrieve Apache Kafka User with Credentials
UsersApi clusters_users_get GET /clusters/{clusterId}/users Retrieve all Users

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

  • Type: Bearer authentication (JWT)

Author

support@cloud.ionos.com

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ionoscloud_kafka-1.0.0b1.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ionoscloud_kafka-1.0.0b1-py3-none-any.whl (77.2 kB view details)

Uploaded Python 3

File details

Details for the file ionoscloud_kafka-1.0.0b1.tar.gz.

File metadata

  • Download URL: ionoscloud_kafka-1.0.0b1.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for ionoscloud_kafka-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 ecfa4749b905ec0097bd3098df0412bf70b60e710928257e89381e79a646b2d4
MD5 31359cfcefcc787e39cf47d668334aea
BLAKE2b-256 17d18c02f91fc4659a749f7cf2f937ca7fc13ad473e3a66a3f6ad3b5d9e11ef0

See more details on using hashes here.

File details

Details for the file ionoscloud_kafka-1.0.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for ionoscloud_kafka-1.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 28c2007a8063b4b00aee671aa7ff0575e25b8ea2ebc6a1cb8deb5efaadb768d6
MD5 a6d90e9b4e78f0f86f4c5f1b395cd098
BLAKE2b-256 4f4c8cdba514a2fbf0ff5402907f5e9121ced22d173d6f73b9400f7bedab0dab

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.0b1 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page