# README

Go API client for v2

Cluster Management for Schema Registry 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.

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

ClassMethodHTTP requestDescription
ClustersSrcmV2ApiCreateSrcmV2ClusterPost /srcm/v2/clustersCreate a Cluster
ClustersSrcmV2ApiDeleteSrcmV2ClusterDelete /srcm/v2/clusters/{id}Delete a Cluster
ClustersSrcmV2ApiGetSrcmV2ClusterGet /srcm/v2/clusters/{id}Read a Cluster
ClustersSrcmV2ApiListSrcmV2ClustersGet /srcm/v2/clustersList of Clusters
ClustersSrcmV2ApiUpdateSrcmV2ClusterPatch /srcm/v2/clusters/{id}Update a Cluster
RegionsSrcmV2ApiGetSrcmV2RegionGet /srcm/v2/regions/{id}Read a Region
RegionsSrcmV2ApiListSrcmV2RegionsGet /srcm/v2/regionsList of Regions

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]

# Packages

No description provided by the author
No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorSource instantiates a new ErrorSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorSourceWithDefaults instantiates a new ErrorSource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFailure instantiates a new Failure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFailureWithDefaults instantiates a new Failure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGlobalObjectReference instantiates a new GlobalObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGlobalObjectReferenceWithDefaults instantiates a new GlobalObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListMeta instantiates a new ListMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListMetaWithDefaults instantiates a new ListMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewObjectMeta instantiates a new ObjectMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewObjectMetaWithDefaults instantiates a new ObjectMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewObjectReference instantiates a new ObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewObjectReferenceWithDefaults instantiates a new ObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2Cluster instantiates a new SrcmV2Cluster object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterList instantiates a new SrcmV2ClusterList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterListWithDefaults instantiates a new SrcmV2ClusterList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2ClusterSpec instantiates a new SrcmV2ClusterSpec object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterSpecUpdate instantiates a new SrcmV2ClusterSpecUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterSpecUpdateWithDefaults instantiates a new SrcmV2ClusterSpecUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2ClusterSpecWithDefaults instantiates a new SrcmV2ClusterSpec object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2ClusterStatus instantiates a new SrcmV2ClusterStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterStatusWithDefaults instantiates a new SrcmV2ClusterStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2ClusterUpdate instantiates a new SrcmV2ClusterUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2ClusterUpdateWithDefaults instantiates a new SrcmV2ClusterUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2ClusterWithDefaults instantiates a new SrcmV2Cluster object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2Region instantiates a new SrcmV2Region object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2RegionList instantiates a new SrcmV2RegionList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2RegionListWithDefaults instantiates a new SrcmV2RegionList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2RegionSpec instantiates a new SrcmV2RegionSpec object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSrcmV2RegionSpecWithDefaults instantiates a new SrcmV2RegionSpec object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSrcmV2RegionWithDefaults instantiates a new SrcmV2Region object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Cluster Management for Schema Registry API API v0.0.1-alpha1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Error Describes a particular error encountered while performing an operation.
ErrorSource If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.
Failure Provides information about problems encountered while performing an operation.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GlobalObjectReference ObjectReference provides information for you to locate the referred object.
ListMeta ListMeta describes metadata that resource collections may have.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
ObjectReference ObjectReference provides information for you to locate the referred object.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SrcmV2Cluster `Clusters` objects represent Schema Registry Clusters on Confluent Cloud.
SrcmV2ClusterList `Clusters` objects represent Schema Registry Clusters on Confluent Cloud.
SrcmV2ClusterSpec The desired state of the Cluster.
SrcmV2ClusterSpecUpdate The desired state of the Cluster.
SrcmV2ClusterStatus The status of the Cluster.
SrcmV2ClusterUpdate `Clusters` objects represent Schema Registry Clusters on Confluent Cloud.
SrcmV2Region `Region` objects represent cloud provider regions available when placing Schema Registry clusters.
SrcmV2RegionList `Region` objects represent cloud provider regions available when placing Schema Registry clusters.
SrcmV2RegionSpec The desired state of the Region.

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

ClustersSrcmV2ApiService ClustersSrcmV2Api service.
RegionsSrcmV2ApiService RegionsSrcmV2Api service.
ServerConfigurations stores multiple ServerConfiguration items.