Go API client for v2

This is the Flink Compute Pool management API.

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

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 "./v2"

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
ComputePoolsFcpmV2Api	CreateFcpmV2ComputePool	Post /fcpm/v2/compute-pools	Create a Compute Pool
ComputePoolsFcpmV2Api	DeleteFcpmV2ComputePool	Delete /fcpm/v2/compute-pools/{id}	Delete a Compute Pool
ComputePoolsFcpmV2Api	GetFcpmV2ComputePool	Get /fcpm/v2/compute-pools/{id}	Read a Compute Pool
ComputePoolsFcpmV2Api	ListFcpmV2ComputePools	Get /fcpm/v2/compute-pools	List of Compute Pools
ComputePoolsFcpmV2Api	UpdateFcpmV2ComputePool	Patch /fcpm/v2/compute-pools/{id}	Update a Compute Pool
RegionsFcpmV2Api	ListFcpmV2Regions	Get /fcpm/v2/regions	List of Regions

Documentation For Models

• EnvScopedObjectReference
• Error
• ErrorSource
• Failure
• FcpmV2ComputePool
• FcpmV2ComputePoolList
• FcpmV2ComputePoolSpec
• FcpmV2ComputePoolSpecUpdate
• FcpmV2ComputePoolStatus
• FcpmV2ComputePoolUpdate
• FcpmV2Region
• FcpmV2RegionList
• GlobalObjectReference
• ListMeta
• ObjectMeta
• ObjectReference

Documentation For Authorization

cloud-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)

confluent-sts-access-token

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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]