kafkamgmt

README

Go API client for Kafka Service Fleet Manager

Kafka Service Fleet Manager is a REST API to manage Kafka instances and connectors.

Installation

To install the package to your project use go get:

go get github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkamgmt

Usage

Importing the package

Import the github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkamgmt/apiv1 package into your code:

package main

import (
    "github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkamgmt/apiv1"
)

Basic usage

If you do not need to customise any of the default configuration values you can pass nil to the NewAPIClient constructor:

client := kafkamgmt.NewAPIClient(nil)

kafkas, resp, err := client.DefaultApi.GetKafkas(context.Background()).Execute()

Configuration

You can override the default configuration options:

cfg := kafkamgmt.Config{
    HTTPClient: yourHTTPClient,
    Debug: true,
    BaseURL: "http://localhost:8080",
}

client := kafkamgmt.NewAPIClient(&cfg)

Authentication

The SDK does not directly handle authentication. When creating a new client, pass a http.Client that can handle authentication for you. The recommended way to do this is using the oauth2 library. If you have an OAuth2 access token you can use it with the oauth2 library using:

ctx := context.Background()
ts := oauth2.StaticTokenSource(
    &oauth2.Token{
        AccessToken: ".. your access token ..",
    },
)

tc := oauth2.NewClient(ctx, ts)

client := kafkamgmt.NewAPIClient(&kafkamgmt.Config{
    HTTPClient: tc,
})

kafkas, _, err := client.DefaultApi.GetKafkas(ctx).Execute()

Error handling

Checking specific error codes

import "github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registrymgmt/apiv1/error"

if errors.IsAPIError(err, kafkamgmt.ERROR_4){
 // Do something
}

Obtaining API error

import "github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registrymgmt/apiv1/error"

apiError := errors.GetAPIError(err)
fmt.Println(apiError.Code)

Endpoints

For a full list of the available endpoints, see Documentation for API Endpoints.