client

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: Apache-2.0 Imports: 20 Imported by: 2

README

Morty Go Client

This is the official Morty client auto-generated based on the OpenAPI specification

Any changes to this folder will be overwritten on the next generation.

Installation

Run the following command in your Go project to install the SDK :

# Install the latest version
go get github.com/morty-faas/controller@latest

# Pin a specific version
go get github.com/morty-faas/controller@v0.2.1

In your code, you can import the pkg/client package :

import (
    morty "github.com/morty-faas/controller/pkg/client"
)

Generation

This code base, including this README, is auto-generated using OpenAPI Generator. If you find bugs in the SDK please check if there is an open issue at OpenAPITools/openapi-generator or morty-faas/controller already before opening an issue here.

Documentation

Index

Constants

This section is empty.

Variables

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 FunctionApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Morty APIs API v0.1.1 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 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 CreateFunctionRequest 

type CreateFunctionRequest struct {
	Name  *string `json:"name,omitempty"`
	Image *string `json:"image,omitempty"`
}

CreateFunctionRequest struct for CreateFunctionRequest

func NewCreateFunctionRequest 

func NewCreateFunctionRequest() *CreateFunctionRequest

NewCreateFunctionRequest instantiates a new CreateFunctionRequest 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 NewCreateFunctionRequestWithDefaults 

func NewCreateFunctionRequestWithDefaults() *CreateFunctionRequest

NewCreateFunctionRequestWithDefaults instantiates a new CreateFunctionRequest 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 (*CreateFunctionRequest) GetImage 

func (o *CreateFunctionRequest) GetImage() string

GetImage returns the Image field value if set, zero value otherwise.

func (*CreateFunctionRequest) GetImageOk 

func (o *CreateFunctionRequest) GetImageOk() (*string, bool)

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

func (*CreateFunctionRequest) GetName 

func (o *CreateFunctionRequest) GetName() string

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

func (*CreateFunctionRequest) GetNameOk 

func (o *CreateFunctionRequest) 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 (*CreateFunctionRequest) HasImage 

func (o *CreateFunctionRequest) HasImage() bool

HasImage returns a boolean if a field has been set.

func (*CreateFunctionRequest) HasName 

func (o *CreateFunctionRequest) HasName() bool

HasName returns a boolean if a field has been set.

func (CreateFunctionRequest) MarshalJSON 

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

func (*CreateFunctionRequest) SetImage 

func (o *CreateFunctionRequest) SetImage(v string)

SetImage gets a reference to the given string and assigns it to the Image field.

func (*CreateFunctionRequest) SetName 

func (o *CreateFunctionRequest) SetName(v string)

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

func (CreateFunctionRequest) ToMap 

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

type Error 

type Error struct {
	// Descriptive message of your error
	Message *string `json:"message,omitempty"`
}

Error struct for Error

func NewError 

func NewError() *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

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

func (*Error) HasMessage 

func (o *Error) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (Error) ToMap 

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

type Function 

type Function struct {
	// The identifier of the resource
	Id *string `json:"id,omitempty"`
	// A unique name to your function
	Name string `json:"name"`
	// The URL of the function image
	Image string `json:"image"`
}

Function struct for Function

func NewFunction 

func NewFunction(name string, image string) *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) GetId 

func (o *Function) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*Function) GetIdOk 

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

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

func (*Function) GetImage 

func (o *Function) GetImage() string

GetImage returns the Image field value

func (*Function) GetImageOk 

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

GetImageOk returns a tuple with the Image 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

func (*Function) GetNameOk 

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

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

func (*Function) HasId 

func (o *Function) HasId() bool

HasId returns a boolean if a field has been set.

func (Function) MarshalJSON 

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

func (*Function) SetId 

func (o *Function) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*Function) SetImage 

func (o *Function) SetImage(v string)

SetImage sets field value

func (*Function) SetName 

func (o *Function) SetName(v string)

SetName sets field value

func (Function) ToMap 

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

type FunctionApi 

type FunctionApi interface {

	/*
		CreateFunction Create a new function

		Create a new function in the system to be able to invoke it later.

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

	// CreateFunctionExecute executes the request
	//  @return Function
	CreateFunctionExecute(r FunctionApiCreateFunctionRequest) (*Function, *http.Response, error)

	/*
		GetFunctions Get a list of the available functions

		Get a list of the available functions

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

	// GetFunctionsExecute executes the request
	//  @return []Function
	GetFunctionsExecute(r FunctionApiGetFunctionsRequest) ([]Function, *http.Response, error)
}

type FunctionApiCreateFunctionRequest 

type FunctionApiCreateFunctionRequest struct {
	ApiService FunctionApi
	// contains filtered or unexported fields
}

func (FunctionApiCreateFunctionRequest) CreateFunctionRequest 

func (r FunctionApiCreateFunctionRequest) CreateFunctionRequest(createFunctionRequest CreateFunctionRequest) FunctionApiCreateFunctionRequest

func (FunctionApiCreateFunctionRequest) Execute 

func (r FunctionApiCreateFunctionRequest) Execute() (*Function, *http.Response, error)

type FunctionApiGetFunctionsRequest 

type FunctionApiGetFunctionsRequest struct {
	ApiService FunctionApi
	// contains filtered or unexported fields
}

func (FunctionApiGetFunctionsRequest) Execute 

func (r FunctionApiGetFunctionsRequest) Execute() ([]Function, *http.Response, error)

type FunctionApiService 

type FunctionApiService service

FunctionApiService FunctionApi service

func (*FunctionApiService) CreateFunction 

func (a *FunctionApiService) CreateFunction(ctx context.Context) FunctionApiCreateFunctionRequest

CreateFunction Create a new function

Create a new function in the system to be able to invoke it later. 

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

func (*FunctionApiService) CreateFunctionExecute 

func (a *FunctionApiService) CreateFunctionExecute(r FunctionApiCreateFunctionRequest) (*Function, *http.Response, error)

Execute executes the request 

@return Function

func (*FunctionApiService) GetFunctions 

func (a *FunctionApiService) GetFunctions(ctx context.Context) FunctionApiGetFunctionsRequest

GetFunctions Get a list of the available functions

Get a list of the available functions 

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

func (*FunctionApiService) GetFunctionsExecute 

func (a *FunctionApiService) GetFunctionsExecute(r FunctionApiGetFunctionsRequest) ([]Function, *http.Response, error)

Execute executes the request 

@return []Function

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 NullableCreateFunctionRequest 

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

func NewNullableCreateFunctionRequest 

func NewNullableCreateFunctionRequest(val *CreateFunctionRequest) *NullableCreateFunctionRequest

func (NullableCreateFunctionRequest) Get 

func (v NullableCreateFunctionRequest) Get() *CreateFunctionRequest

func (NullableCreateFunctionRequest) IsSet 

func (v NullableCreateFunctionRequest) IsSet() bool

func (NullableCreateFunctionRequest) MarshalJSON 

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

func (*NullableCreateFunctionRequest) Set 

func (v *NullableCreateFunctionRequest) Set(val *CreateFunctionRequest)

func (*NullableCreateFunctionRequest) UnmarshalJSON 

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

func (*NullableCreateFunctionRequest) Unset 

func (v *NullableCreateFunctionRequest) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

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

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.