api

package
v0.0.123 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2024 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Handler 

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux 

func HandlerFromMux(si ServerInterface, r *mux.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL 

func HandlerFromMuxWithBaseURL(si ServerInterface, r *mux.Router, baseURL string) http.Handler

func HandlerWithOptions 

func HandlerWithOptions(si ServerInterface, options GorillaServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

Types

type CallSemantics 

type CallSemantics int

CallSemantics defines model for CallSemantics. 

const (
	FunctionCall     CallSemantics = 1
	Inherited        CallSemantics = 0
	PriorityTaskPool CallSemantics = 3
	TaskPool         CallSemantics = 2
)

Defines values for CallSemantics.

type CommunicationProtocol 

type CommunicationProtocol int

CommunicationProtocol defines model for CommunicationProtocol. 

const (
	CommunicationProtocolGRPC CommunicationProtocol = 2
	CommunicationProtocolHTTP CommunicationProtocol = 1
)

Defines values for CommunicationProtocol.

type DataConnector 

type DataConnector struct {
	Host                *string                     `json:"host,omitempty"`
	Id                  int                         `json:"id"`
	Implementation      DataConnectorImplementation `json:"implementation"`
	Name                string                      `json:"name"`
	Port                *int                        `json:"port,omitempty"`
	ProgrammingLanguage ProgrammingLanguage         `json:"programmingLanguage"`
	Type                DataConnectorType           `json:"type"`
}

DataConnector defines model for DataConnector.

type DataConnectorImplementation 

type DataConnectorImplementation string

DataConnectorImplementation defines model for DataConnectorImplementation. 

const (
	FastHTTP DataConnectorImplementation = "FastHTTP"
	Nethttp  DataConnectorImplementation = "net/http"
)

Defines values for DataConnectorImplementation.

type DataConnectorType 

type DataConnectorType int

DataConnectorType defines model for DataConnectorType. 

const (
	DataConnectorTypeCustom DataConnectorType = 4
	DataConnectorTypeGRPC   DataConnectorType = 2
	DataConnectorTypeHTTP   DataConnectorType = 1
	DataConnectorTypeKafka  DataConnectorType = 3
)

Defines values for DataConnectorType.

type DataFormat 

type DataFormat string

DataFormat defines model for DataFormat. 

const (
	Gorillaschema DataFormat = "gorilla/schema"
	Json          DataFormat = "json"
)

Defines values for DataFormat.

type DataType 

type DataType string

DataType defines model for DataType. 

const (
	DataTypeArray         DataType = "array"
	DataTypeBoolean       DataType = "boolean"
	DataTypeByte          DataType = "byte"
	DataTypeChar          DataType = "char"
	DataTypeCustom        DataType = "custom"
	DataTypeDouble        DataType = "double"
	DataTypeFloat         DataType = "float"
	DataTypeInt           DataType = "int"
	DataTypeInt16         DataType = "int16"
	DataTypeInt32         DataType = "int32"
	DataTypeInt64         DataType = "int64"
	DataTypeInt8          DataType = "int8"
	DataTypeMap           DataType = "map"
	DataTypeString        DataType = "string"
	DataTypeStruct        DataType = "struct"
	DataTypeUint          DataType = "uint"
	DataTypeUint16        DataType = "uint16"
	DataTypeUint32        DataType = "uint32"
	DataTypeUint64        DataType = "uint64"
	DataTypeUint8         DataType = "uint8"
	DataTypeUnicodeChar   DataType = "unicode char"
	DataTypeUnicodeString DataType = "unicode string"
)

Defines values for DataType.

type Endpoint 

type Endpoint struct {
	Delay           *int        `json:"delay,omitempty"`
	Format          *DataFormat `json:"format,omitempty"`
	FunctionName    *string     `json:"functionName,omitempty"`
	FunctionPackage *string     `json:"functionPackage,omitempty"`
	Id              int         `json:"id"`
	IdDataConnector int         `json:"idDataConnector"`
	Method          *string     `json:"method,omitempty"`
	Name            string      `json:"name"`
	Param           *string     `json:"param,omitempty"`
	Path            *string     `json:"path,omitempty"`
	PublicFunction  *bool       `json:"publicFunction,omitempty"`
}

Endpoint defines model for Endpoint.

type GorillaServerOptions 

type GorillaServerOptions struct {
	BaseURL          string
	BaseRouter       *mux.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type InvalidParamFormatError 

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error 

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap 

func (e *InvalidParamFormatError) Unwrap() error

type JoinStorageType 

type JoinStorageType int

JoinStorageType defines model for JoinStorageType. 

const (
	Aerospike JoinStorageType = 3
	HashMap   JoinStorageType = 1
	RocksDB   JoinStorageType = 2
)

Defines values for JoinStorageType.

type JoinType 

type JoinType int

JoinType defines model for JoinType. 

const (
	Inner JoinType = 1
	Left  JoinType = 2
	Outer JoinType = 4
	Right JoinType = 3
)

Defines values for JoinType. 

type Link struct {
	CallSemantics          CallSemantics          `json:"callSemantics"`
	CommunicationProtocol  *CommunicationProtocol `json:"communicationProtocol,omitempty"`
	From                   int                    `json:"from"`
	InheritedCallSemantics bool                   `json:"inheritedCallSemantics"`
	MethodName             *string                `json:"methodName,omitempty"`
	PoolName               *string                `json:"poolName,omitempty"`
	Priority               *int                   `json:"priority,omitempty"`
	Timeout                *int                   `json:"timeout,omitempty"`
	To                     int                    `json:"to"`
}

Link defines model for Link.

type MetricsEngine 

type MetricsEngine int

MetricsEngine defines model for MetricsEngine. 

const (
	Prometeus MetricsEngine = 1
)

Defines values for MetricsEngine.

type MiddlewareFunc 

type MiddlewareFunc func(http.Handler) http.Handler

type PostGenerateCodeJSONRequestBody 

type PostGenerateCodeJSONRequestBody = StreamApp

PostGenerateCodeJSONRequestBody defines body for PostGenerateCode for application/json ContentType.

type ProgrammingLanguage 

type ProgrammingLanguage int

ProgrammingLanguage defines model for ProgrammingLanguage. 

const (
	Cpp    ProgrammingLanguage = 2
	GoLang ProgrammingLanguage = 1
	Python ProgrammingLanguage = 3
)

Defines values for ProgrammingLanguage.

type ProjectSettings 

type ProjectSettings struct {
	GolangVersion string `json:"golangVersion"`
	ModulePath    string `json:"modulePath"`
	Name          string `json:"name"`
}

ProjectSettings defines model for ProjectSettings.

type RequiredHeaderError 

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error 

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap 

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError 

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error 

func (e *RequiredParamError) Error() string

type ServerInterface 

type ServerInterface interface {
	// Generate project code.
	// (POST /generateCode)
	PostGenerateCode(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) PostGenerateCode 

func (siw *ServerInterfaceWrapper) PostGenerateCode(w http.ResponseWriter, r *http.Request)

PostGenerateCode operation middleware

type Service 

type Service struct {
	Color                *string             `json:"color,omitempty"`
	DefaultCallSemantics CallSemantics       `json:"defaultCallSemantics"`
	DefaultGrpcTimeout   int                 `json:"defaultGrpcTimeout"`
	DelayExecutors       int                 `json:"delayExecutors"`
	Environment          string              `json:"environment"`
	GrpcHost             string              `json:"grpcHost"`
	GrpcPort             int                 `json:"grpcPort"`
	Id                   int                 `json:"id"`
	MetricsEngine        MetricsEngine       `json:"metricsEngine"`
	MonitoringHost       string              `json:"monitoringHost"`
	MonitoringPort       int                 `json:"monitoringPort"`
	Name                 string              `json:"name"`
	ProgrammingLanguage  ProgrammingLanguage `json:"programmingLanguage"`
	ShutdownTimeout      int                 `json:"shutdownTimeout"`
}

Service defines model for Service.

type Stream 

type Stream struct {
	Duration        *int               `json:"duration,omitempty"`
	FunctionName    *string            `json:"functionName,omitempty"`
	FunctionPackage *string            `json:"functionPackage,omitempty"`
	Id              int                `json:"id"`
	IdEndpoint      *int               `json:"idEndpoint,omitempty"`
	IdService       int                `json:"idService"`
	IdSource        int                `json:"idSource"`
	IdSources       []int              `json:"idSources"`
	JoinStorage     *JoinStorageType   `json:"joinStorage,omitempty"`
	JoinType        *JoinType          `json:"joinType,omitempty"`
	KeyType         *string            `json:"keyType,omitempty"`
	Name            string             `json:"name"`
	PublicFunction  *bool              `json:"publicFunction,omitempty"`
	RenewTTL        *bool              `json:"renewTTL,omitempty"`
	Ttl             *int               `json:"ttl,omitempty"`
	Type            TransformationType `json:"type"`
	ValueType       *string            `json:"valueType,omitempty"`
	XPos            *int               `json:"xPos,omitempty"`
	YPos            *int               `json:"yPos,omitempty"`
}

Stream defines model for Stream.

type StreamApp 

type StreamApp struct {
	DataConnectors []DataConnector `json:"dataConnectors"`
	Endpoints      []Endpoint      `json:"endpoints"`
	Links          []Link          `json:"links"`
	Services       []Service       `json:"services"`
	Settings       ProjectSettings `json:"settings"`
	Streams        []Stream        `json:"streams"`
	Types          []Type          `json:"types"`
}

StreamApp defines model for StreamApp.

type StringBinary 

type StringBinary = openapi_types.File

StringBinary defines model for StringBinary.

type TooManyValuesForParamError 

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error 

func (e *TooManyValuesForParamError) Error() string

type TransformationType 

type TransformationType int

TransformationType defines model for TransformationType. 

const (
	TransformationTypeAppSink         TransformationType = 14
	TransformationTypeCycleLink       TransformationType = 15
	TransformationTypeDelay           TransformationType = 16
	TransformationTypeFilter          TransformationType = 3
	TransformationTypeFlatMap         TransformationType = 7
	TransformationTypeFlatMapIterable TransformationType = 8
	TransformationTypeForEach         TransformationType = 6
	TransformationTypeInput           TransformationType = 1
	TransformationTypeJoin            TransformationType = 4
	TransformationTypeKeyBy           TransformationType = 9
	TransformationTypeMap             TransformationType = 2
	TransformationTypeMerge           TransformationType = 10
	TransformationTypeMultiJoin       TransformationType = 5
	TransformationTypeParallels       TransformationType = 12
	TransformationTypeSink            TransformationType = 13
	TransformationTypeSplit           TransformationType = 11
)

Defines values for TransformationType.

type Type 

type Type struct {
	DefinitionFormat    *TypeDefinitionFormat `json:"definitionFormat,omitempty"`
	KeyType             *string               `json:"keyType,omitempty"`
	Name                string                `json:"name"`
	Package             *string               `json:"package,omitempty"`
	PublicType          *bool                 `json:"publicType,omitempty"`
	TransferByValue     *bool                 `json:"transferByValue,omitempty"`
	Type                DataType              `json:"type"`
	TypeDefinitionLang1 *string               `json:"typeDefinitionLang1,omitempty"`
	TypeDefinitionLang2 *string               `json:"typeDefinitionLang2,omitempty"`
	TypeImportLang1     *string               `json:"typeImportLang1,omitempty"`
	TypeImportLang2     *string               `json:"typeImportLang2,omitempty"`
	UseAlias            *bool                 `json:"useAlias,omitempty"`
	ValueType           *string               `json:"valueType,omitempty"`
}

Type defines model for Type.

type TypeDefinitionFormat 

type TypeDefinitionFormat int

TypeDefinitionFormat defines model for TypeDefinitionFormat. 

const (
	CapNProto   TypeDefinitionFormat = 4
	FlatBuffers TypeDefinitionFormat = 3
	Native      TypeDefinitionFormat = 1
	Protobuf    TypeDefinitionFormat = 2
)

Defines values for TypeDefinitionFormat.

type UnescapedCookieParamError 

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error 

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap 

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError 

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error 

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap 

func (e *UnmarshalingParamError) Unwrap() error

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.