restclient

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for restclient

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.

  • API version: 0.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/net/context

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

import restclient "github.com/functionstream/functionstream/restclient"

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 restclient.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), restclient.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value restclient.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), restclient.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 restclient.ContextOperationServerIndices and restclient.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), restclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), restclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:7300

Class Method HTTP request Description
DefaultAPI ApiV1ConsumeQueueNameGet Get /api/v1/consume/{queue_name} Consumes an event from a queue
DefaultAPI ApiV1FunctionFunctionNameDelete Delete /api/v1/function/{function_name} Deletes a function
DefaultAPI ApiV1FunctionFunctionNamePost Post /api/v1/function/{function_name} Starts a function
DefaultAPI ApiV1FunctionsGet Get /api/v1/functions Returns a list of functions
DefaultAPI ApiV1ProduceQueueNamePut Put /api/v1/produce/{queue_name} Produces an event to a queue

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

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

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

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	DefaultAPI *DefaultAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Function Stream API API v0.1.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) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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 OpenAPI 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:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiApiV1ConsumeQueueNameGetRequest 

type ApiApiV1ConsumeQueueNameGetRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiApiV1ConsumeQueueNameGetRequest) Execute 

func (r ApiApiV1ConsumeQueueNameGetRequest) Execute() (string, *http.Response, error)

type ApiApiV1FunctionFunctionNameDeleteRequest 

type ApiApiV1FunctionFunctionNameDeleteRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiApiV1FunctionFunctionNameDeleteRequest) Execute 

func (r ApiApiV1FunctionFunctionNameDeleteRequest) Execute() (*http.Response, error)

type ApiApiV1FunctionFunctionNamePostRequest 

type ApiApiV1FunctionFunctionNamePostRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiApiV1FunctionFunctionNamePostRequest) Execute 

func (r ApiApiV1FunctionFunctionNamePostRequest) Execute() (*http.Response, error)

func (ApiApiV1FunctionFunctionNamePostRequest) Function 

func (r ApiApiV1FunctionFunctionNamePostRequest) Function(function Function) ApiApiV1FunctionFunctionNamePostRequest

type ApiApiV1FunctionsGetRequest 

type ApiApiV1FunctionsGetRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiApiV1FunctionsGetRequest) Execute 

func (r ApiApiV1FunctionsGetRequest) Execute() ([]string, *http.Response, error)

type ApiApiV1ProduceQueueNamePutRequest 

type ApiApiV1ProduceQueueNamePutRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiApiV1ProduceQueueNamePutRequest) Body 

func (r ApiApiV1ProduceQueueNamePutRequest) Body(body string) ApiApiV1ProduceQueueNamePutRequest

func (ApiApiV1ProduceQueueNamePutRequest) Execute 

func (r ApiApiV1ProduceQueueNamePutRequest) Execute() (*http.Response, error)

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 {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DefaultAPIService 

type DefaultAPIService service

DefaultAPIService DefaultAPI service

func (*DefaultAPIService) ApiV1ConsumeQueueNameGet 

func (a *DefaultAPIService) ApiV1ConsumeQueueNameGet(ctx context.Context, queueName string) ApiApiV1ConsumeQueueNameGetRequest

ApiV1ConsumeQueueNameGet Consumes an event from a queue 

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

func (*DefaultAPIService) ApiV1ConsumeQueueNameGetExecute 

func (a *DefaultAPIService) ApiV1ConsumeQueueNameGetExecute(r ApiApiV1ConsumeQueueNameGetRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*DefaultAPIService) ApiV1FunctionFunctionNameDelete 

func (a *DefaultAPIService) ApiV1FunctionFunctionNameDelete(ctx context.Context, functionName string) ApiApiV1FunctionFunctionNameDeleteRequest

ApiV1FunctionFunctionNameDelete Deletes a function 

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

func (*DefaultAPIService) ApiV1FunctionFunctionNameDeleteExecute 

func (a *DefaultAPIService) ApiV1FunctionFunctionNameDeleteExecute(r ApiApiV1FunctionFunctionNameDeleteRequest) (*http.Response, error)

Execute executes the request

func (*DefaultAPIService) ApiV1FunctionFunctionNamePost 

func (a *DefaultAPIService) ApiV1FunctionFunctionNamePost(ctx context.Context, functionName string) ApiApiV1FunctionFunctionNamePostRequest

ApiV1FunctionFunctionNamePost Starts a function 

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

func (*DefaultAPIService) ApiV1FunctionFunctionNamePostExecute 

func (a *DefaultAPIService) ApiV1FunctionFunctionNamePostExecute(r ApiApiV1FunctionFunctionNamePostRequest) (*http.Response, error)

Execute executes the request

func (*DefaultAPIService) ApiV1FunctionsGet 

func (a *DefaultAPIService) ApiV1FunctionsGet(ctx context.Context) ApiApiV1FunctionsGetRequest

ApiV1FunctionsGet Returns a list of functions 

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

func (*DefaultAPIService) ApiV1FunctionsGetExecute 

func (a *DefaultAPIService) ApiV1FunctionsGetExecute(r ApiApiV1FunctionsGetRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

func (*DefaultAPIService) ApiV1ProduceQueueNamePut 

func (a *DefaultAPIService) ApiV1ProduceQueueNamePut(ctx context.Context, queueName string) ApiApiV1ProduceQueueNamePutRequest

ApiV1ProduceQueueNamePut Produces an event to a queue 

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

func (*DefaultAPIService) ApiV1ProduceQueueNamePutExecute 

func (a *DefaultAPIService) ApiV1ProduceQueueNamePutExecute(r ApiApiV1ProduceQueueNamePutRequest) (*http.Response, error)

Execute executes the request

type Function 

type Function struct {
	Name     *string            `json:"name,omitempty"`
	Runtime  *FunctionRuntime   `json:"runtime,omitempty"`
	Source   *FunctionSource    `json:"source,omitempty"`
	Sink     *FunctionSource    `json:"sink,omitempty"`
	Inputs   []string           `json:"inputs"`
	Output   string             `json:"output"`
	Config   *map[string]string `json:"config,omitempty"`
	Replicas int32              `json:"replicas"`
}

Function struct for Function

func NewFunction 

func NewFunction(inputs []string, output string, replicas int32) *Function

NewFunction instantiates a new Function 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

func NewFunctionWithDefaults 

func NewFunctionWithDefaults() *Function

NewFunctionWithDefaults instantiates a new Function 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

func (*Function) GetConfig 

func (o *Function) GetConfig() map[string]string

GetConfig returns the Config field value if set, zero value otherwise.

func (*Function) GetConfigOk 

func (o *Function) GetConfigOk() (*map[string]string, bool)

GetConfigOk returns a tuple with the Config field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Function) GetInputs 

func (o *Function) GetInputs() []string

GetInputs returns the Inputs field value

func (*Function) GetInputsOk 

func (o *Function) GetInputsOk() ([]string, bool)

GetInputsOk returns a tuple with the Inputs field value and a boolean to check if the value has been set.

func (*Function) GetName 

func (o *Function) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*Function) GetNameOk 

func (o *Function) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Function) GetOutput 

func (o *Function) GetOutput() string

GetOutput returns the Output field value

func (*Function) GetOutputOk 

func (o *Function) GetOutputOk() (*string, bool)

GetOutputOk returns a tuple with the Output field value and a boolean to check if the value has been set.

func (*Function) GetReplicas 

func (o *Function) GetReplicas() int32

GetReplicas returns the Replicas field value

func (*Function) GetReplicasOk 

func (o *Function) GetReplicasOk() (*int32, bool)

GetReplicasOk returns a tuple with the Replicas field value and a boolean to check if the value has been set.

func (*Function) GetRuntime 

func (o *Function) GetRuntime() FunctionRuntime

GetRuntime returns the Runtime field value if set, zero value otherwise.

func (*Function) GetRuntimeOk 

func (o *Function) GetRuntimeOk() (*FunctionRuntime, bool)

GetRuntimeOk returns a tuple with the Runtime field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Function) GetSink 

func (o *Function) GetSink() FunctionSource

GetSink returns the Sink field value if set, zero value otherwise.

func (*Function) GetSinkOk 

func (o *Function) GetSinkOk() (*FunctionSource, bool)

GetSinkOk returns a tuple with the Sink field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Function) GetSource 

func (o *Function) GetSource() FunctionSource

GetSource returns the Source field value if set, zero value otherwise.

func (*Function) GetSourceOk 

func (o *Function) GetSourceOk() (*FunctionSource, bool)

GetSourceOk returns a tuple with the Source field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Function) HasConfig 

func (o *Function) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*Function) HasName 

func (o *Function) HasName() bool

HasName returns a boolean if a field has been set.

func (*Function) HasRuntime 

func (o *Function) HasRuntime() bool

HasRuntime returns a boolean if a field has been set.

func (*Function) HasSink 

func (o *Function) HasSink() bool

HasSink returns a boolean if a field has been set.

func (*Function) HasSource 

func (o *Function) HasSource() bool

HasSource returns a boolean if a field has been set.

func (Function) MarshalJSON 

func (o Function) MarshalJSON() ([]byte, error)

func (*Function) SetConfig 

func (o *Function) SetConfig(v map[string]string)

SetConfig gets a reference to the given map[string]string and assigns it to the Config field.

func (*Function) SetInputs 

func (o *Function) SetInputs(v []string)

SetInputs sets field value

func (*Function) SetName 

func (o *Function) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*Function) SetOutput 

func (o *Function) SetOutput(v string)

SetOutput sets field value

func (*Function) SetReplicas 

func (o *Function) SetReplicas(v int32)

SetReplicas sets field value

func (*Function) SetRuntime 

func (o *Function) SetRuntime(v FunctionRuntime)

SetRuntime gets a reference to the given FunctionRuntime and assigns it to the Runtime field.

func (*Function) SetSink 

func (o *Function) SetSink(v FunctionSource)

SetSink gets a reference to the given FunctionSource and assigns it to the Sink field.

func (*Function) SetSource 

func (o *Function) SetSource(v FunctionSource)

SetSource gets a reference to the given FunctionSource and assigns it to the Source field.

func (Function) ToMap 

func (o Function) ToMap() (map[string]interface{}, error)

func (*Function) UnmarshalJSON 

func (o *Function) UnmarshalJSON(data []byte) (err error)

type FunctionRuntime 

type FunctionRuntime struct {
	Config map[string]interface{} `json:"config,omitempty"`
	Type   NullableString         `json:"type,omitempty"`
}

FunctionRuntime struct for FunctionRuntime

func NewFunctionRuntime 

func NewFunctionRuntime() *FunctionRuntime

NewFunctionRuntime instantiates a new FunctionRuntime 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

func NewFunctionRuntimeWithDefaults 

func NewFunctionRuntimeWithDefaults() *FunctionRuntime

NewFunctionRuntimeWithDefaults instantiates a new FunctionRuntime 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

func (*FunctionRuntime) GetConfig 

func (o *FunctionRuntime) GetConfig() map[string]interface{}

GetConfig returns the Config field value if set, zero value otherwise.

func (*FunctionRuntime) GetConfigOk 

func (o *FunctionRuntime) GetConfigOk() (map[string]interface{}, bool)

GetConfigOk returns a tuple with the Config field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FunctionRuntime) GetType 

func (o *FunctionRuntime) GetType() string

GetType returns the Type field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FunctionRuntime) GetTypeOk 

func (o *FunctionRuntime) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FunctionRuntime) HasConfig 

func (o *FunctionRuntime) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*FunctionRuntime) HasType 

func (o *FunctionRuntime) HasType() bool

HasType returns a boolean if a field has been set.

func (FunctionRuntime) MarshalJSON 

func (o FunctionRuntime) MarshalJSON() ([]byte, error)

func (*FunctionRuntime) SetConfig 

func (o *FunctionRuntime) SetConfig(v map[string]interface{})

SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field.

func (*FunctionRuntime) SetType 

func (o *FunctionRuntime) SetType(v string)

SetType gets a reference to the given NullableString and assigns it to the Type field.

func (*FunctionRuntime) SetTypeNil 

func (o *FunctionRuntime) SetTypeNil()

SetTypeNil sets the value for Type to be an explicit nil

func (FunctionRuntime) ToMap 

func (o FunctionRuntime) ToMap() (map[string]interface{}, error)

func (*FunctionRuntime) UnsetType 

func (o *FunctionRuntime) UnsetType()

UnsetType ensures that no value is present for Type, not even an explicit nil

type FunctionSource 

type FunctionSource struct {
	Config map[string]interface{} `json:"config,omitempty"`
	Type   NullableString         `json:"type,omitempty"`
}

FunctionSource struct for FunctionSource

func NewFunctionSource 

func NewFunctionSource() *FunctionSource

NewFunctionSource instantiates a new FunctionSource 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

func NewFunctionSourceWithDefaults 

func NewFunctionSourceWithDefaults() *FunctionSource

NewFunctionSourceWithDefaults instantiates a new FunctionSource 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

func (*FunctionSource) GetConfig 

func (o *FunctionSource) GetConfig() map[string]interface{}

GetConfig returns the Config field value if set, zero value otherwise.

func (*FunctionSource) GetConfigOk 

func (o *FunctionSource) GetConfigOk() (map[string]interface{}, bool)

GetConfigOk returns a tuple with the Config field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FunctionSource) GetType 

func (o *FunctionSource) GetType() string

GetType returns the Type field value if set, zero value otherwise (both if not set or set to explicit null).

func (*FunctionSource) GetTypeOk 

func (o *FunctionSource) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*FunctionSource) HasConfig 

func (o *FunctionSource) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*FunctionSource) HasType 

func (o *FunctionSource) HasType() bool

HasType returns a boolean if a field has been set.

func (FunctionSource) MarshalJSON 

func (o FunctionSource) MarshalJSON() ([]byte, error)

func (*FunctionSource) SetConfig 

func (o *FunctionSource) SetConfig(v map[string]interface{})

SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field.

func (*FunctionSource) SetType 

func (o *FunctionSource) SetType(v string)

SetType gets a reference to the given NullableString and assigns it to the Type field.

func (*FunctionSource) SetTypeNil 

func (o *FunctionSource) SetTypeNil()

SetTypeNil sets the value for Type to be an explicit nil

func (FunctionSource) ToMap 

func (o FunctionSource) ToMap() (map[string]interface{}, error)

func (*FunctionSource) UnsetType 

func (o *FunctionSource) UnsetType()

UnsetType ensures that no value is present for Type, not even an explicit nil

type GenericOpenAPIError 

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

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

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableFunction 

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

func NewNullableFunction 

func NewNullableFunction(val *Function) *NullableFunction

func (NullableFunction) Get 

func (v NullableFunction) Get() *Function

func (NullableFunction) IsSet 

func (v NullableFunction) IsSet() bool

func (NullableFunction) MarshalJSON 

func (v NullableFunction) MarshalJSON() ([]byte, error)

func (*NullableFunction) Set 

func (v *NullableFunction) Set(val *Function)

func (*NullableFunction) UnmarshalJSON 

func (v *NullableFunction) UnmarshalJSON(src []byte) error

func (*NullableFunction) Unset 

func (v *NullableFunction) Unset()

type NullableFunctionRuntime 

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

func NewNullableFunctionRuntime 

func NewNullableFunctionRuntime(val *FunctionRuntime) *NullableFunctionRuntime

func (NullableFunctionRuntime) Get 

func (v NullableFunctionRuntime) Get() *FunctionRuntime

func (NullableFunctionRuntime) IsSet 

func (v NullableFunctionRuntime) IsSet() bool

func (NullableFunctionRuntime) MarshalJSON 

func (v NullableFunctionRuntime) MarshalJSON() ([]byte, error)

func (*NullableFunctionRuntime) Set 

func (v *NullableFunctionRuntime) Set(val *FunctionRuntime)

func (*NullableFunctionRuntime) UnmarshalJSON 

func (v *NullableFunctionRuntime) UnmarshalJSON(src []byte) error

func (*NullableFunctionRuntime) Unset 

func (v *NullableFunctionRuntime) Unset()

type NullableFunctionSource 

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

func NewNullableFunctionSource 

func NewNullableFunctionSource(val *FunctionSource) *NullableFunctionSource

func (NullableFunctionSource) Get 

func (v NullableFunctionSource) Get() *FunctionSource

func (NullableFunctionSource) IsSet 

func (v NullableFunctionSource) IsSet() bool

func (NullableFunctionSource) MarshalJSON 

func (v NullableFunctionSource) MarshalJSON() ([]byte, error)

func (*NullableFunctionSource) Set 

func (v *NullableFunctionSource) Set(val *FunctionSource)

func (*NullableFunctionSource) UnmarshalJSON 

func (v *NullableFunctionSource) UnmarshalJSON(src []byte) error

func (*NullableFunctionSource) Unset 

func (v *NullableFunctionSource) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableRuntimeConfig 

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

func NewNullableRuntimeConfig 

func NewNullableRuntimeConfig(val *RuntimeConfig) *NullableRuntimeConfig

func (NullableRuntimeConfig) Get 

func (v NullableRuntimeConfig) Get() *RuntimeConfig

func (NullableRuntimeConfig) IsSet 

func (v NullableRuntimeConfig) IsSet() bool

func (NullableRuntimeConfig) MarshalJSON 

func (v NullableRuntimeConfig) MarshalJSON() ([]byte, error)

func (*NullableRuntimeConfig) Set 

func (v *NullableRuntimeConfig) Set(val *RuntimeConfig)

func (*NullableRuntimeConfig) UnmarshalJSON 

func (v *NullableRuntimeConfig) UnmarshalJSON(src []byte) error

func (*NullableRuntimeConfig) Unset 

func (v *NullableRuntimeConfig) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableTubeConfig 

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

func NewNullableTubeConfig 

func NewNullableTubeConfig(val *TubeConfig) *NullableTubeConfig

func (NullableTubeConfig) Get 

func (v NullableTubeConfig) Get() *TubeConfig

func (NullableTubeConfig) IsSet 

func (v NullableTubeConfig) IsSet() bool

func (NullableTubeConfig) MarshalJSON 

func (v NullableTubeConfig) MarshalJSON() ([]byte, error)

func (*NullableTubeConfig) Set 

func (v *NullableTubeConfig) Set(val *TubeConfig)

func (*NullableTubeConfig) UnmarshalJSON 

func (v *NullableTubeConfig) UnmarshalJSON(src []byte) error

func (*NullableTubeConfig) Unset 

func (v *NullableTubeConfig) Unset()

type RuntimeConfig 

type RuntimeConfig struct {
	Config map[string]interface{} `json:"config,omitempty"`
	Type   NullableString         `json:"type,omitempty"`
}

RuntimeConfig struct for RuntimeConfig

func NewRuntimeConfig 

func NewRuntimeConfig() *RuntimeConfig

NewRuntimeConfig instantiates a new RuntimeConfig 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

func NewRuntimeConfigWithDefaults 

func NewRuntimeConfigWithDefaults() *RuntimeConfig

NewRuntimeConfigWithDefaults instantiates a new RuntimeConfig 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

func (*RuntimeConfig) GetConfig 

func (o *RuntimeConfig) GetConfig() map[string]interface{}

GetConfig returns the Config field value if set, zero value otherwise.

func (*RuntimeConfig) GetConfigOk 

func (o *RuntimeConfig) GetConfigOk() (map[string]interface{}, bool)

GetConfigOk returns a tuple with the Config field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RuntimeConfig) GetType 

func (o *RuntimeConfig) GetType() string

GetType returns the Type field value if set, zero value otherwise (both if not set or set to explicit null).

func (*RuntimeConfig) GetTypeOk 

func (o *RuntimeConfig) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*RuntimeConfig) HasConfig 

func (o *RuntimeConfig) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*RuntimeConfig) HasType 

func (o *RuntimeConfig) HasType() bool

HasType returns a boolean if a field has been set.

func (RuntimeConfig) MarshalJSON 

func (o RuntimeConfig) MarshalJSON() ([]byte, error)

func (*RuntimeConfig) SetConfig 

func (o *RuntimeConfig) SetConfig(v map[string]interface{})

SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field.

func (*RuntimeConfig) SetType 

func (o *RuntimeConfig) SetType(v string)

SetType gets a reference to the given NullableString and assigns it to the Type field.

func (*RuntimeConfig) SetTypeNil 

func (o *RuntimeConfig) SetTypeNil()

SetTypeNil sets the value for Type to be an explicit nil

func (RuntimeConfig) ToMap 

func (o RuntimeConfig) ToMap() (map[string]interface{}, error)

func (*RuntimeConfig) UnsetType 

func (o *RuntimeConfig) UnsetType()

UnsetType ensures that no value is present for Type, not even an explicit nil

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TubeConfig 

type TubeConfig struct {
	Config map[string]interface{} `json:"config,omitempty"`
	Type   NullableString         `json:"type,omitempty"`
}

TubeConfig struct for TubeConfig

func NewTubeConfig 

func NewTubeConfig() *TubeConfig

NewTubeConfig instantiates a new TubeConfig 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

func NewTubeConfigWithDefaults 

func NewTubeConfigWithDefaults() *TubeConfig

NewTubeConfigWithDefaults instantiates a new TubeConfig 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

func (*TubeConfig) GetConfig 

func (o *TubeConfig) GetConfig() map[string]interface{}

GetConfig returns the Config field value if set, zero value otherwise.

func (*TubeConfig) GetConfigOk 

func (o *TubeConfig) GetConfigOk() (map[string]interface{}, bool)

GetConfigOk returns a tuple with the Config field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TubeConfig) GetType 

func (o *TubeConfig) GetType() string

GetType returns the Type field value if set, zero value otherwise (both if not set or set to explicit null).

func (*TubeConfig) GetTypeOk 

func (o *TubeConfig) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*TubeConfig) HasConfig 

func (o *TubeConfig) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*TubeConfig) HasType 

func (o *TubeConfig) HasType() bool

HasType returns a boolean if a field has been set.

func (TubeConfig) MarshalJSON 

func (o TubeConfig) MarshalJSON() ([]byte, error)

func (*TubeConfig) SetConfig 

func (o *TubeConfig) SetConfig(v map[string]interface{})

SetConfig gets a reference to the given map[string]interface{} and assigns it to the Config field.

func (*TubeConfig) SetType 

func (o *TubeConfig) SetType(v string)

SetType gets a reference to the given NullableString and assigns it to the Type field.

func (*TubeConfig) SetTypeNil 

func (o *TubeConfig) SetTypeNil()

SetTypeNil sets the value for Type to be an explicit nil

func (TubeConfig) ToMap 

func (o TubeConfig) ToMap() (map[string]interface{}, error)

func (*TubeConfig) UnsetType 

func (o *TubeConfig) UnsetType()

UnsetType ensures that no value is present for Type, not even an explicit nil

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.