Go API client for openapi

Authentication

The REST API can be used with your Personal Access Token (PAT). You don't know what a PAT is, check our documentation here.

After you created a PAT click on Authorize and add your PAT under BearerAuth.

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.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

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 openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), openapi.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(), openapi.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(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://cloud.exasol.com

Class	Method	HTTP request	Description
ClustersApi	CreateCluster	Post /api/v1/accounts/{accountID}/databases/{databaseID}/clusters	Create cluster
ClustersApi	DeleteCluster	Delete /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}	Delete cluster
ClustersApi	GetCluster	Get /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}	Get cluster
ClustersApi	GetClusterConnection	Get /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}/connect	Get connection information
ClustersApi	ListClusters	Get /api/v1/accounts/{accountID}/databases/{databaseID}/clusters	List clusters
ClustersApi	ScaleCluster	Put /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}/scale	Scale cluster
ClustersApi	StartCluster	Put /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}/start	Start cluster
ClustersApi	StopCluster	Put /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}/stop	Stop cluster
ClustersApi	UpdateCluster	Put /api/v1/accounts/{accountID}/databases/{databaseID}/clusters/{clusterID}	Update cluster
DatabasesApi	CreateDatabase	Post /api/v1/accounts/{accountID}/databases	Create database
DatabasesApi	DeleteDatabase	Delete /api/v1/accounts/{accountID}/databases/{databaseID}	Delete database
DatabasesApi	GetDatabase	Get /api/v1/accounts/{accountID}/databases/{databaseID}	Get database
DatabasesApi	ListDatabases	Get /api/v1/accounts/{accountID}/databases	List databases
DatabasesApi	StartDatabase	Put /api/v1/accounts/{accountID}/databases/{databaseID}/start	Start database
DatabasesApi	StopDatabase	Put /api/v1/accounts/{accountID}/databases/{databaseID}/stop	Stop database
DatabasesApi	UpdateDatabase	Put /api/v1/accounts/{accountID}/databases/{databaseID}	Update database
PlatformApi	ListClusterSizes	Get /api/v1/platforms/{platform}/sizes	Get cluster sizes for platform
PlatformApi	ListPlatforms	Get /api/v1/platforms	List platforms
PlatformApi	ListRegions	Get /api/v1/platforms/{platform}/regions	Get regions for platform
SecurityApi	AddAllowedIP	Post /api/v1/accounts/{accountID}/security/allowlist_ip	Add security rule (CIDR)
SecurityApi	DeleteAllowedIP	Delete /api/v1/accounts/{accountID}/security/allowlist_ip/{ID}	Delete security rule (CIDR)
SecurityApi	GetAllowedIP	Get /api/v1/accounts/{accountID}/security/allowlist_ip/{ID}	Get security rule (CIDR)
SecurityApi	ListAllowedIPs	Get /api/v1/accounts/{accountID}/security/allowlist_ip	List security rules (CIDR)
SecurityApi	UpdateAllowedIP	Put /api/v1/accounts/{accountID}/security/allowlist_ip/{ID}	Update security rule (CIDR)
UsageApi	GetUsage	Get /api/v1/accounts/{accountID}/usage	Get usage
UsersApi	DeleteUser	Delete /api/v1/accounts/{accountID}/users/{userID}	Remove user
UsersApi	ListUsers	Get /api/v1/accounts/{accountID}/users	List users
UsersApi	PatchUser	Patch /api/v1/accounts/{accountID}/users/{userID}	Patch user
UsersApi	UpdateUser	Put /api/v1/accounts/{accountID}/users/{userID}	Update user

Documentation For Models

Documentation For Authorization

BearerAuth

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:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

# README