# README

Go API client for v1

Introduction

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: 0.1.0-alpha0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://confluent.slack.com/app_redirect?channel=data-exchange-eng

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./v1"

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(), sw.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(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.confluent.cloud

Class	Method	HTTP request	Description
ConsumerSharedResourcesCdxV1Api	GetCdxV1ConsumerSharedResource	Get /cdx/v1/consumer-shared-resources/{id}	Read a Consumer Shared Resource
ConsumerSharedResourcesCdxV1Api	ImageCdxV1ConsumerSharedResource	Get /cdx/v1/consumer-shared-resources/{id}/images/{file_name}	Get image for shared resource
ConsumerSharedResourcesCdxV1Api	ListCdxV1ConsumerSharedResources	Get /cdx/v1/consumer-shared-resources	List of Consumer Shared Resources
ConsumerSharedResourcesCdxV1Api	NetworkCdxV1ConsumerSharedResource	Get /cdx/v1/consumer-shared-resources/{id}:network	Get shared resource's network configuration
ConsumerSharesCdxV1Api	DeleteCdxV1ConsumerShare	Delete /cdx/v1/consumer-shares/{id}	Delete a Consumer Share
ConsumerSharesCdxV1Api	GetCdxV1ConsumerShare	Get /cdx/v1/consumer-shares/{id}	Read a Consumer Share
ConsumerSharesCdxV1Api	ListCdxV1ConsumerShares	Get /cdx/v1/consumer-shares	List of Consumer Shares
OptInsCdxV1Api	GetCdxV1OptIn	Get /cdx/v1/opt-in	Read the organization's stream sharing opt-in settings
OptInsCdxV1Api	UpdateCdxV1OptIn	Patch /cdx/v1/opt-in	Set the organization's stream sharing opt-in settings
ProviderSharedResourcesCdxV1Api	DeleteImageCdxV1ProviderSharedResource	Delete /cdx/v1/provider-shared-resources/{id}/images/{file_name}	Delete_Image a Provider Shared Resource
ProviderSharedResourcesCdxV1Api	GetCdxV1ProviderSharedResource	Get /cdx/v1/provider-shared-resources/{id}	Read a Provider Shared Resource
ProviderSharedResourcesCdxV1Api	ListCdxV1ProviderSharedResources	Get /cdx/v1/provider-shared-resources	List of Provider Shared Resources
ProviderSharedResourcesCdxV1Api	UpdateCdxV1ProviderSharedResource	Patch /cdx/v1/provider-shared-resources/{id}	Update a Provider Shared Resource
ProviderSharedResourcesCdxV1Api	UploadImageCdxV1ProviderSharedResource	Post /cdx/v1/provider-shared-resources/{id}/images/{file_name}	Upload image for shared resource
ProviderSharedResourcesCdxV1Api	ViewImageCdxV1ProviderSharedResource	Get /cdx/v1/provider-shared-resources/{id}/images/{file_name}	View_Image a Provider Shared Resource
ProviderSharesCdxV1Api	CreateCdxV1ProviderShare	Post /cdx/v1/provider-shares	Create a provider share
ProviderSharesCdxV1Api	DeleteCdxV1ProviderShare	Delete /cdx/v1/provider-shares/{id}	Delete a Provider Share
ProviderSharesCdxV1Api	GetCdxV1ProviderShare	Get /cdx/v1/provider-shares/{id}	Read a Provider Share
ProviderSharesCdxV1Api	ListCdxV1ProviderShares	Get /cdx/v1/provider-shares	List of Provider Shares
ProviderSharesCdxV1Api	ResendCdxV1ProviderShare	Post /cdx/v1/provider-shares/{id}:resend	Resend
SharedTokensCdxV1Api	RedeemCdxV1SharedToken	Post /cdx/v1/shared-tokens:redeem	Redeem token
SharedTokensCdxV1Api	ResourcesCdxV1SharedToken	Post /cdx/v1/shared-tokens:resources	Validate token to view shared resources

Documentation For Models

Documentation For Authorization

api-key

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
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:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]