platformapi

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 17, 2020 License: Apache-2.0 Imports: 19 Imported by: 0

README

Go API client for platformApiClient

The Ververica Platform APIs, excluding Application Manager.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://www.ververica.com

Installation

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

import "./platformApiClient"

Documentation for API Endpoints

All URIs are relative to https://localhost:8081

Class Method HTTP request Description
ApiTokensApi CreateApiToken Post /apitokens/v1/namespaces/{ns}/apitokens createApiToken
ApiTokensApi DeleteApiToken Delete /apitokens/v1/namespaces/{ns}/apitokens/{apiTokenName} deleteApiToken
ApiTokensApi GetApiToken Get /apitokens/v1/namespaces/{ns}/apitokens/{apiTokenName} getApiToken
ApiTokensApi ListApiTokens Get /apitokens/v1/namespaces/{ns}/apitokens listApiTokens
NamespacesApi CreateNamespace Post /namespaces/v1/namespaces createNamespace
NamespacesApi DeleteNamespace Delete /namespaces/v1/namespaces/{ns} deleteNamespace
NamespacesApi GetNamespace Get /namespaces/v1/namespaces/{ns} getNamespace
NamespacesApi ListNamespaces Get /namespaces/v1/namespaces listNamespaces
NamespacesApi UpdateNamespace Put /namespaces/v1/namespaces/{ns} updateNamespace

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

platform@ververica.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ApiTokensApi *ApiTokensApiService

	NamespacesApi *NamespacesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Ververica Platform API API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ApiToken 

type ApiToken struct {
	CreateTime *time.Time `json:"createTime,omitempty"`
	Name       string     `json:"name,omitempty"`
	Role       string     `json:"role,omitempty"`
	Secret     string     `json:"secret,omitempty"`
}

type ApiTokensApiService 

type ApiTokensApiService service

func (*ApiTokensApiService) CreateApiToken 

func (a *ApiTokensApiService) CreateApiToken(ctx context.Context, apiToken ApiToken, ns string) (CreateApiTokenResponse, *http.Response, error)

ApiTokensApiService createApiToken

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apiToken apiToken
  • @param ns ns

@return CreateApiTokenResponse

func (*ApiTokensApiService) DeleteApiToken 

func (a *ApiTokensApiService) DeleteApiToken(ctx context.Context, apiTokenName string, ns string) (DeleteApiTokenResponse, *http.Response, error)

ApiTokensApiService deleteApiToken

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apiTokenName apiTokenName
  • @param ns ns

@return DeleteApiTokenResponse

func (*ApiTokensApiService) GetApiToken 

func (a *ApiTokensApiService) GetApiToken(ctx context.Context, apiTokenName string, ns string) (GetApiTokenResponse, *http.Response, error)

ApiTokensApiService getApiToken

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apiTokenName apiTokenName
  • @param ns ns

@return GetApiTokenResponse

func (*ApiTokensApiService) ListApiTokens 

func (a *ApiTokensApiService) ListApiTokens(ctx context.Context, ns string) (ListApiTokensResponse, *http.Response, error)

ApiTokensApiService listApiTokens

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ns ns

@return ListApiTokensResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateApiTokenResponse 

type CreateApiTokenResponse struct {
	ApiToken *ApiToken `json:"apiToken,omitempty"`
}

type CreateNamespaceResponse 

type CreateNamespaceResponse struct {
	Namespace *Namespace `json:"namespace,omitempty"`
}

type DeleteApiTokenResponse 

type DeleteApiTokenResponse struct {
}

type DeleteNamespaceResponse 

type DeleteNamespaceResponse struct {
	Namespace *Namespace `json:"namespace,omitempty"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

func (GenericSwaggerError) StatusCode 

func (e GenericSwaggerError) StatusCode() int

StatusCode returns the response status code

func (GenericSwaggerError) WithStatusCode 

func (e GenericSwaggerError) WithStatusCode(statusCode int) GenericSwaggerError

type GetApiTokenResponse 

type GetApiTokenResponse struct {
	ApiToken *ApiToken `json:"apiToken,omitempty"`
}

type GetNamespaceResponse 

type GetNamespaceResponse struct {
	Namespace *Namespace `json:"namespace,omitempty"`
}

type ListApiTokensResponse 

type ListApiTokensResponse struct {
	ApiTokens []ApiToken `json:"apiTokens,omitempty"`
}

type ListNamespacesResponse 

type ListNamespacesResponse struct {
	Namespaces []Namespace `json:"namespaces,omitempty"`
}

type Namespace 

type Namespace struct {
	CreateTime     *time.Time    `json:"createTime,omitempty"`
	LifecyclePhase string        `json:"lifecyclePhase,omitempty"`
	Name           string        `json:"name,omitempty"`
	RoleBindings   []RoleBinding `json:"roleBindings,omitempty"`
}

type NamespacesApiService 

type NamespacesApiService service

func (*NamespacesApiService) CreateNamespace 

func (a *NamespacesApiService) CreateNamespace(ctx context.Context, namespace Namespace) (CreateNamespaceResponse, *http.Response, error)

NamespacesApiService createNamespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespace namespace

@return CreateNamespaceResponse

func (*NamespacesApiService) DeleteNamespace 

func (a *NamespacesApiService) DeleteNamespace(ctx context.Context, ns string) (DeleteNamespaceResponse, *http.Response, error)

NamespacesApiService deleteNamespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ns ns

@return DeleteNamespaceResponse

func (*NamespacesApiService) GetNamespace 

func (a *NamespacesApiService) GetNamespace(ctx context.Context, ns string) (GetNamespaceResponse, *http.Response, error)

NamespacesApiService getNamespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ns ns

@return GetNamespaceResponse

func (*NamespacesApiService) ListNamespaces 

func (a *NamespacesApiService) ListNamespaces(ctx context.Context) (ListNamespacesResponse, *http.Response, error)

NamespacesApiService listNamespaces

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ListNamespacesResponse

func (*NamespacesApiService) UpdateNamespace 

func (a *NamespacesApiService) UpdateNamespace(ctx context.Context, namespace Namespace, ns string) (UpdateNamespaceResponse, *http.Response, error)

NamespacesApiService updateNamespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param namespace namespace
  • @param ns ns

@return UpdateNamespaceResponse

type RoleBinding 

type RoleBinding struct {
	Members []string `json:"members,omitempty"`
	Role    string   `json:"role,omitempty"`
}

type UpdateNamespaceResponse 

type UpdateNamespaceResponse struct {
	Namespace *Namespace `json:"namespace,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.