adminclient

package
v0.4.0 Latest Latest
Warning

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

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

README

Go API client for adminclient

Manage Function Stream Resources

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.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/FunctionStream

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 adminclient "github.com/functionstream/functionstream/admin/client"

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

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

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

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

ctx := context.WithValue(context.Background(), adminclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), adminclient.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
FunctionAPI CreateFunction Post /api/v1/function create a function
FunctionAPI DeleteFunction Delete /api/v1/function/{name} delete a function
FunctionAPI DeleteNamespacedFunction Delete /api/v1/function/{namespace}/{name} delete a namespaced function
FunctionAPI GetAllFunctions Get /api/v1/function get all functions
HttpTubeAPI TriggerHttpTubeEndpoint Post /api/v1/http-tube/{endpoint} trigger the http tube endpoint
StateAPI GetState Get /api/v1/state/{key} get a state
StateAPI SetState Post /api/v1/state/{key} set a state
StatusAPI GetStatus Get /api/v1/status Get the status of the Function Stream
TubeAPI ConsumeMessage Get /api/v1/consume/{name} consume a message
TubeAPI ProduceMessage Post /api/v1/produce/{name} produce a message

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 {
	FunctionAPI *FunctionAPIService

	HttpTubeAPI *HttpTubeAPIService

	StateAPI *StateAPIService

	StatusAPI *StatusAPIService

	TubeAPI *TubeAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Function Stream Service API v1.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) 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 ApiConsumeMessageRequest 

type ApiConsumeMessageRequest struct {
	ApiService *TubeAPIService
	// contains filtered or unexported fields
}

func (ApiConsumeMessageRequest) Execute 

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

type ApiCreateFunctionRequest 

type ApiCreateFunctionRequest struct {
	ApiService *FunctionAPIService
	// contains filtered or unexported fields
}

func (ApiCreateFunctionRequest) Body 

func (r ApiCreateFunctionRequest) Body(body ModelFunction) ApiCreateFunctionRequest

func (ApiCreateFunctionRequest) Execute 

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

type ApiDeleteFunctionRequest 

type ApiDeleteFunctionRequest struct {
	ApiService *FunctionAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteFunctionRequest) Execute 

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

type ApiDeleteNamespacedFunctionRequest 

type ApiDeleteNamespacedFunctionRequest struct {
	ApiService *FunctionAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteNamespacedFunctionRequest) Execute 

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

type ApiGetAllFunctionsRequest 

type ApiGetAllFunctionsRequest struct {
	ApiService *FunctionAPIService
	// contains filtered or unexported fields
}

func (ApiGetAllFunctionsRequest) Execute 

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

type ApiGetStateRequest 

type ApiGetStateRequest struct {
	ApiService *StateAPIService
	// contains filtered or unexported fields
}

func (ApiGetStateRequest) Execute 

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

type ApiGetStatusRequest 

type ApiGetStatusRequest struct {
	ApiService *StatusAPIService
	// contains filtered or unexported fields
}

func (ApiGetStatusRequest) Execute 

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

type ApiProduceMessageRequest 

type ApiProduceMessageRequest struct {
	ApiService *TubeAPIService
	// contains filtered or unexported fields
}

func (ApiProduceMessageRequest) Body 

func (r ApiProduceMessageRequest) Body(body string) ApiProduceMessageRequest

func (ApiProduceMessageRequest) Execute 

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

type ApiSetStateRequest 

type ApiSetStateRequest struct {
	ApiService *StateAPIService
	// contains filtered or unexported fields
}

func (ApiSetStateRequest) Body 

func (r ApiSetStateRequest) Body(body string) ApiSetStateRequest

func (ApiSetStateRequest) Execute 

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

type ApiTriggerHttpTubeEndpointRequest 

type ApiTriggerHttpTubeEndpointRequest struct {
	ApiService *HttpTubeAPIService
	// contains filtered or unexported fields
}

func (ApiTriggerHttpTubeEndpointRequest) Body 

func (r ApiTriggerHttpTubeEndpointRequest) Body(body string) ApiTriggerHttpTubeEndpointRequest

func (ApiTriggerHttpTubeEndpointRequest) Execute 

func (r ApiTriggerHttpTubeEndpointRequest) 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 FunctionAPIService 

type FunctionAPIService service

FunctionAPIService FunctionAPI service

func (*FunctionAPIService) CreateFunction 

func (a *FunctionAPIService) CreateFunction(ctx context.Context) ApiCreateFunctionRequest

CreateFunction create a function 

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

func (*FunctionAPIService) CreateFunctionExecute 

func (a *FunctionAPIService) CreateFunctionExecute(r ApiCreateFunctionRequest) (*http.Response, error)

Execute executes the request

func (*FunctionAPIService) DeleteFunction 

func (a *FunctionAPIService) DeleteFunction(ctx context.Context, name string) ApiDeleteFunctionRequest

DeleteFunction delete a function 

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

func (*FunctionAPIService) DeleteFunctionExecute 

func (a *FunctionAPIService) DeleteFunctionExecute(r ApiDeleteFunctionRequest) (*http.Response, error)

Execute executes the request

func (*FunctionAPIService) DeleteNamespacedFunction 

func (a *FunctionAPIService) DeleteNamespacedFunction(ctx context.Context, name string, namespace string) ApiDeleteNamespacedFunctionRequest

DeleteNamespacedFunction delete a namespaced function 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name name of the function
@param namespace namespace of the function
@return ApiDeleteNamespacedFunctionRequest

func (*FunctionAPIService) DeleteNamespacedFunctionExecute 

func (a *FunctionAPIService) DeleteNamespacedFunctionExecute(r ApiDeleteNamespacedFunctionRequest) (*http.Response, error)

Execute executes the request

func (*FunctionAPIService) GetAllFunctions 

func (a *FunctionAPIService) GetAllFunctions(ctx context.Context) ApiGetAllFunctionsRequest

GetAllFunctions get all functions 

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

func (*FunctionAPIService) GetAllFunctionsExecute 

func (a *FunctionAPIService) GetAllFunctionsExecute(r ApiGetAllFunctionsRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

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 HttpTubeAPIService 

type HttpTubeAPIService service

HttpTubeAPIService HttpTubeAPI service

func (*HttpTubeAPIService) TriggerHttpTubeEndpoint 

func (a *HttpTubeAPIService) TriggerHttpTubeEndpoint(ctx context.Context, endpoint string) ApiTriggerHttpTubeEndpointRequest

TriggerHttpTubeEndpoint trigger the http tube endpoint 

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

func (*HttpTubeAPIService) TriggerHttpTubeEndpointExecute 

func (a *HttpTubeAPIService) TriggerHttpTubeEndpointExecute(r ApiTriggerHttpTubeEndpointRequest) (*http.Response, error)

Execute executes the request

type MappedNullable 

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

type ModelFunction 

type ModelFunction struct {
	Config    *map[string]string `json:"config,omitempty"`
	Name      string             `json:"name"`
	Namespace *string            `json:"namespace,omitempty"`
	Replicas  int32              `json:"replicas"`
	Runtime   ModelRuntimeConfig `json:"runtime"`
	Sink      *ModelTubeConfig   `json:"sink,omitempty"`
	Source    []ModelTubeConfig  `json:"source,omitempty"`
}

ModelFunction struct for ModelFunction

func NewModelFunction 

func NewModelFunction(name string, replicas int32, runtime ModelRuntimeConfig) *ModelFunction

NewModelFunction instantiates a new ModelFunction 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 NewModelFunctionWithDefaults 

func NewModelFunctionWithDefaults() *ModelFunction

NewModelFunctionWithDefaults instantiates a new ModelFunction 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 (*ModelFunction) GetConfig 

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

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

func (*ModelFunction) GetConfigOk 

func (o *ModelFunction) 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 (*ModelFunction) GetName 

func (o *ModelFunction) GetName() string

GetName returns the Name field value

func (*ModelFunction) GetNameOk 

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

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

func (*ModelFunction) GetNamespace 

func (o *ModelFunction) GetNamespace() string

GetNamespace returns the Namespace field value if set, zero value otherwise.

func (*ModelFunction) GetNamespaceOk 

func (o *ModelFunction) GetNamespaceOk() (*string, bool)

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

func (*ModelFunction) GetReplicas 

func (o *ModelFunction) GetReplicas() int32

GetReplicas returns the Replicas field value

func (*ModelFunction) GetReplicasOk 

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

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

func (*ModelFunction) GetRuntime 

func (o *ModelFunction) GetRuntime() ModelRuntimeConfig

GetRuntime returns the Runtime field value

func (*ModelFunction) GetRuntimeOk 

func (o *ModelFunction) GetRuntimeOk() (*ModelRuntimeConfig, bool)

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

func (*ModelFunction) GetSink 

func (o *ModelFunction) GetSink() ModelTubeConfig

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

func (*ModelFunction) GetSinkOk 

func (o *ModelFunction) GetSinkOk() (*ModelTubeConfig, 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 (*ModelFunction) GetSource 

func (o *ModelFunction) GetSource() []ModelTubeConfig

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

func (*ModelFunction) GetSourceOk 

func (o *ModelFunction) GetSourceOk() ([]ModelTubeConfig, 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 (*ModelFunction) HasConfig 

func (o *ModelFunction) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*ModelFunction) HasNamespace 

func (o *ModelFunction) HasNamespace() bool

HasNamespace returns a boolean if a field has been set.

func (*ModelFunction) HasSink 

func (o *ModelFunction) HasSink() bool

HasSink returns a boolean if a field has been set.

func (*ModelFunction) HasSource 

func (o *ModelFunction) HasSource() bool

HasSource returns a boolean if a field has been set.

func (ModelFunction) MarshalJSON 

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

func (*ModelFunction) SetConfig 

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

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

func (*ModelFunction) SetName 

func (o *ModelFunction) SetName(v string)

SetName sets field value

func (*ModelFunction) SetNamespace 

func (o *ModelFunction) SetNamespace(v string)

SetNamespace gets a reference to the given string and assigns it to the Namespace field.

func (*ModelFunction) SetReplicas 

func (o *ModelFunction) SetReplicas(v int32)

SetReplicas sets field value

func (*ModelFunction) SetRuntime 

func (o *ModelFunction) SetRuntime(v ModelRuntimeConfig)

SetRuntime sets field value

func (*ModelFunction) SetSink 

func (o *ModelFunction) SetSink(v ModelTubeConfig)

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

func (*ModelFunction) SetSource 

func (o *ModelFunction) SetSource(v []ModelTubeConfig)

SetSource gets a reference to the given []ModelTubeConfig and assigns it to the Source field.

func (ModelFunction) ToMap 

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

func (*ModelFunction) UnmarshalJSON 

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

type ModelRuntimeConfig 

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

ModelRuntimeConfig struct for ModelRuntimeConfig

func NewModelRuntimeConfig 

func NewModelRuntimeConfig() *ModelRuntimeConfig

NewModelRuntimeConfig instantiates a new ModelRuntimeConfig 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 NewModelRuntimeConfigWithDefaults 

func NewModelRuntimeConfigWithDefaults() *ModelRuntimeConfig

NewModelRuntimeConfigWithDefaults instantiates a new ModelRuntimeConfig 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 (*ModelRuntimeConfig) GetConfig 

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

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

func (*ModelRuntimeConfig) GetConfigOk 

func (o *ModelRuntimeConfig) 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 (*ModelRuntimeConfig) GetType 

func (o *ModelRuntimeConfig) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ModelRuntimeConfig) GetTypeOk 

func (o *ModelRuntimeConfig) 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.

func (*ModelRuntimeConfig) HasConfig 

func (o *ModelRuntimeConfig) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*ModelRuntimeConfig) HasType 

func (o *ModelRuntimeConfig) HasType() bool

HasType returns a boolean if a field has been set.

func (ModelRuntimeConfig) MarshalJSON 

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

func (*ModelRuntimeConfig) SetConfig 

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

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

func (*ModelRuntimeConfig) SetType 

func (o *ModelRuntimeConfig) SetType(v string)

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

func (ModelRuntimeConfig) ToMap 

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

type ModelTubeConfig 

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

ModelTubeConfig struct for ModelTubeConfig

func NewModelTubeConfig 

func NewModelTubeConfig() *ModelTubeConfig

NewModelTubeConfig instantiates a new ModelTubeConfig 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 NewModelTubeConfigWithDefaults 

func NewModelTubeConfigWithDefaults() *ModelTubeConfig

NewModelTubeConfigWithDefaults instantiates a new ModelTubeConfig 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 (*ModelTubeConfig) GetConfig 

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

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

func (*ModelTubeConfig) GetConfigOk 

func (o *ModelTubeConfig) 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 (*ModelTubeConfig) GetType 

func (o *ModelTubeConfig) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ModelTubeConfig) GetTypeOk 

func (o *ModelTubeConfig) 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.

func (*ModelTubeConfig) HasConfig 

func (o *ModelTubeConfig) HasConfig() bool

HasConfig returns a boolean if a field has been set.

func (*ModelTubeConfig) HasType 

func (o *ModelTubeConfig) HasType() bool

HasType returns a boolean if a field has been set.

func (ModelTubeConfig) MarshalJSON 

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

func (*ModelTubeConfig) SetConfig 

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

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

func (*ModelTubeConfig) SetType 

func (o *ModelTubeConfig) SetType(v string)

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

func (ModelTubeConfig) ToMap 

func (o ModelTubeConfig) 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 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 NullableModelFunction 

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

func NewNullableModelFunction 

func NewNullableModelFunction(val *ModelFunction) *NullableModelFunction

func (NullableModelFunction) Get 

func (v NullableModelFunction) Get() *ModelFunction

func (NullableModelFunction) IsSet 

func (v NullableModelFunction) IsSet() bool

func (NullableModelFunction) MarshalJSON 

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

func (*NullableModelFunction) Set 

func (v *NullableModelFunction) Set(val *ModelFunction)

func (*NullableModelFunction) UnmarshalJSON 

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

func (*NullableModelFunction) Unset 

func (v *NullableModelFunction) Unset()

type NullableModelRuntimeConfig 

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

func NewNullableModelRuntimeConfig 

func NewNullableModelRuntimeConfig(val *ModelRuntimeConfig) *NullableModelRuntimeConfig

func (NullableModelRuntimeConfig) Get 

func (v NullableModelRuntimeConfig) Get() *ModelRuntimeConfig

func (NullableModelRuntimeConfig) IsSet 

func (v NullableModelRuntimeConfig) IsSet() bool

func (NullableModelRuntimeConfig) MarshalJSON 

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

func (*NullableModelRuntimeConfig) Set 

func (v *NullableModelRuntimeConfig) Set(val *ModelRuntimeConfig)

func (*NullableModelRuntimeConfig) UnmarshalJSON 

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

func (*NullableModelRuntimeConfig) Unset 

func (v *NullableModelRuntimeConfig) Unset()

type NullableModelTubeConfig 

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

func NewNullableModelTubeConfig 

func NewNullableModelTubeConfig(val *ModelTubeConfig) *NullableModelTubeConfig

func (NullableModelTubeConfig) Get 

func (v NullableModelTubeConfig) Get() *ModelTubeConfig

func (NullableModelTubeConfig) IsSet 

func (v NullableModelTubeConfig) IsSet() bool

func (NullableModelTubeConfig) MarshalJSON 

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

func (*NullableModelTubeConfig) Set 

func (v *NullableModelTubeConfig) Set(val *ModelTubeConfig)

func (*NullableModelTubeConfig) UnmarshalJSON 

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

func (*NullableModelTubeConfig) Unset 

func (v *NullableModelTubeConfig) Unset()

type NullableRestfulspecSchemaType 

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

func NewNullableRestfulspecSchemaType 

func NewNullableRestfulspecSchemaType(val *RestfulspecSchemaType) *NullableRestfulspecSchemaType

func (NullableRestfulspecSchemaType) Get 

func (v NullableRestfulspecSchemaType) Get() *RestfulspecSchemaType

func (NullableRestfulspecSchemaType) IsSet 

func (v NullableRestfulspecSchemaType) IsSet() bool

func (NullableRestfulspecSchemaType) MarshalJSON 

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

func (*NullableRestfulspecSchemaType) Set 

func (v *NullableRestfulspecSchemaType) Set(val *RestfulspecSchemaType)

func (*NullableRestfulspecSchemaType) UnmarshalJSON 

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

func (*NullableRestfulspecSchemaType) Unset 

func (v *NullableRestfulspecSchemaType) 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 RestfulspecSchemaType 

type RestfulspecSchemaType struct {
	Format  string `json:"Format"`
	RawType string `json:"RawType"`
}

RestfulspecSchemaType struct for RestfulspecSchemaType

func NewRestfulspecSchemaType 

func NewRestfulspecSchemaType(format string, rawType string) *RestfulspecSchemaType

NewRestfulspecSchemaType instantiates a new RestfulspecSchemaType 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 NewRestfulspecSchemaTypeWithDefaults 

func NewRestfulspecSchemaTypeWithDefaults() *RestfulspecSchemaType

NewRestfulspecSchemaTypeWithDefaults instantiates a new RestfulspecSchemaType 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 (*RestfulspecSchemaType) GetFormat 

func (o *RestfulspecSchemaType) GetFormat() string

GetFormat returns the Format field value

func (*RestfulspecSchemaType) GetFormatOk 

func (o *RestfulspecSchemaType) GetFormatOk() (*string, bool)

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

func (*RestfulspecSchemaType) GetRawType 

func (o *RestfulspecSchemaType) GetRawType() string

GetRawType returns the RawType field value

func (*RestfulspecSchemaType) GetRawTypeOk 

func (o *RestfulspecSchemaType) GetRawTypeOk() (*string, bool)

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

func (RestfulspecSchemaType) MarshalJSON 

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

func (*RestfulspecSchemaType) SetFormat 

func (o *RestfulspecSchemaType) SetFormat(v string)

SetFormat sets field value

func (*RestfulspecSchemaType) SetRawType 

func (o *RestfulspecSchemaType) SetRawType(v string)

SetRawType sets field value

func (RestfulspecSchemaType) ToMap 

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

func (*RestfulspecSchemaType) UnmarshalJSON 

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

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 StateAPIService 

type StateAPIService service

StateAPIService StateAPI service

func (*StateAPIService) GetState 

func (a *StateAPIService) GetState(ctx context.Context, key string) ApiGetStateRequest

GetState get a state 

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

func (*StateAPIService) GetStateExecute 

func (a *StateAPIService) GetStateExecute(r ApiGetStateRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*StateAPIService) SetState 

func (a *StateAPIService) SetState(ctx context.Context, key string) ApiSetStateRequest

SetState set a state 

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

func (*StateAPIService) SetStateExecute 

func (a *StateAPIService) SetStateExecute(r ApiSetStateRequest) (*http.Response, error)

Execute executes the request

type StatusAPIService 

type StatusAPIService service

StatusAPIService StatusAPI service

func (*StatusAPIService) GetStatus 

func (a *StatusAPIService) GetStatus(ctx context.Context) ApiGetStatusRequest

GetStatus Get the status of the Function Stream 

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

func (*StatusAPIService) GetStatusExecute 

func (a *StatusAPIService) GetStatusExecute(r ApiGetStatusRequest) (*http.Response, error)

Execute executes the request

type TubeAPIService 

type TubeAPIService service

TubeAPIService TubeAPI service

func (*TubeAPIService) ConsumeMessage 

func (a *TubeAPIService) ConsumeMessage(ctx context.Context, name string) ApiConsumeMessageRequest

ConsumeMessage consume a message 

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

func (*TubeAPIService) ConsumeMessageExecute 

func (a *TubeAPIService) ConsumeMessageExecute(r ApiConsumeMessageRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*TubeAPIService) ProduceMessage 

func (a *TubeAPIService) ProduceMessage(ctx context.Context, name string) ApiProduceMessageRequest

ProduceMessage produce a message 

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

func (*TubeAPIService) ProduceMessageExecute 

func (a *TubeAPIService) ProduceMessageExecute(r ApiProduceMessageRequest) (*http.Response, error)

Execute executes the request

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.