# README
Go API client for ionoscloud
An 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.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.7.1
- Package version: 1.1.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://docs.ionos.com/support/general-information/contact-information
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import ionoscloud "github.com/ionos-cloud/sdk-go-kafka"
To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
Documentation for API Endpoints
All URIs are relative to https://kafka.de-fra.ionos.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ClustersApi | ClustersDelete | Delete /clusters/{clusterId} | Delete Cluster |
| ClustersApi | ClustersFindById | Get /clusters/{clusterId} | Retrieve Cluster |
| ClustersApi | ClustersGet | Get /clusters | Retrieve all Clusters |
| ClustersApi | ClustersPost | Post /clusters | Create Cluster |
| TopicsApi | ClustersTopicsDelete | Delete /clusters/{clusterId}/topics/{topicId} | Delete Topic |
| TopicsApi | ClustersTopicsFindById | Get /clusters/{clusterId}/topics/{topicId} | Retrieve Topic |
| TopicsApi | ClustersTopicsGet | Get /clusters/{clusterId}/topics | Retrieve all Topics |
| TopicsApi | ClustersTopicsPost | Post /clusters/{clusterId}/topics | Create Topic |
| UsersApi | ClustersUsersAccessGet | Get /clusters/{clusterId}/users/{userId}/access | Retrieve Kafka User with credentials. |
| UsersApi | ClustersUsersGet | Get /clusters/{clusterId}/users | Retrieve all Users |
Documentation For Models
- Cluster
- ClusterCreate
- ClusterMetadata
- ClusterMetadataAllOf
- ClusterRead
- ClusterReadList
- ClusterReadListAllOf
- Error
- ErrorMessages
- KafkaClusterConnection
- Links
- Metadata
- Pagination
- ResourceMetadata
- ResourceState
- Topic
- TopicCreate
- TopicLogRetention
- TopicRead
- TopicReadList
- TopicReadListAllOf
- User
- UserAccessMetadata
- UserAccessMetadataAllOf
- UserRead
- UserReadAccess
- UserReadList
- UserReadListAllOf
Documentation For Authorization
Authentication schemes defined for the API:
tokenAuth
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime