Skip to content

Latest commit

 

History

History
155 lines (112 loc) · 6.1 KB

README.md

File metadata and controls

155 lines (112 loc) · 6.1 KB
Raw

Go API client for v1

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.

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://flink.region.provider.confluent.cloud

Class Method HTTP request Description
StatementExceptionsSqlV1Api GetSqlv1StatementExceptions Get /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions List of Statement Exceptions
StatementResultsSqlV1Api GetSqlv1StatementResult Get /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results Read Statement Result
StatementsSqlV1Api CreateSqlv1Statement Post /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements Create a Statement
StatementsSqlV1Api DeleteSqlv1Statement Delete /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name} Delete a Statement
StatementsSqlV1Api GetSqlv1Statement Get /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name} Read a Statement
StatementsSqlV1Api ListSqlv1Statements Get /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements List of Statements
StatementsSqlV1Api UpdateSqlv1Statement Put /sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name} Update a Statement

Documentation For Models

Documentation For Authorization

resource-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

flink-control-plane@confluent.io