spec

Documentation

Index

• Constants
• type ComponentSpec
• type Connector
• type ConnectorList
• type ConnectorSchema
• type ConnectorSpec
• type FunkionConfig
• type FunktionFlow
• type FunktionStep
• type PropertySpec

Constants

const (
	EndpointKind   = "endpoint"
	FunctionKind   = "function"
	SetBodyKind    = "setBody"
	SetHeadersKind = "setHeaders"
)

Types

type ComponentSpec

type ComponentSpec struct {
	Kind        string `json:"kind"`
	Scheme      string `json:"scheme"`
	Syntax      string `json:"syntax"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Label       string `json:"label"`
	Deprecated  bool   `json:"deprecated"`
	Async       bool   `json:"async"`
	JavaType    string `json:"javaType"`
	GroupId     string `json:"groupId"`
	ArtifactId  string `json:"artifactId"`
	Version     string `json:"version"`
}

ComponentSpec holds the component metadata in a ConnectorSchema

type Connector

type Connector struct {
	unversioned.TypeMeta `json:",inline"`
	v1.ObjectMeta        `json:"metadata,omitempty"`
	Spec                 ConnectorSpec `json:"spec"`
}

Connector defines how to create a Deployment for a Flow

type ConnectorList

type ConnectorList struct {
	unversioned.TypeMeta `json:",inline"`
	unversioned.ListMeta `json:"metadata,omitempty"`

	Items []*Connector `json:"items"`
}

ConnectorList is a list of Funktion.

type ConnectorSchema

type ConnectorSchema struct {
	Component           ComponentSpec           `json:"component"`
	ComponentProperties map[string]PropertySpec `json:"componentProperties"`
	Properties          map[string]PropertySpec `json:"properties"`
}

ConnectorSchema holds the connector schema and metadata for the connector

type ConnectorSpec

type ConnectorSpec struct {
	DeploymentSpec *v1beta1.DeploymentSpec `json:"deploymentSpec"`
}

ConnectorSpec holds specification parameters of a Flow deployment along with configuration metadata.

type FunkionConfig

type FunkionConfig struct {
	Flows []FunktionFlow `json:"flows"`
}

type FunktionFlow

type FunktionFlow struct {
	Name      string         `json:"name,omitempty"`
	Trace     bool           `json:"trace,omitempty"`
	LogResult bool           `json:"logResult,omitempty"`
	Steps     []FunktionStep `json:"steps"`
}

type FunktionStep

type FunktionStep struct {
	Kind    string            `json:"kind"`
	Name    string            `json:"name,omitempty"`
	URI     string            `json:"uri,omitempty"`
	Body    string            `json:"body,omitempty"`
	Headers map[string]string `json:"headers,omitempty"`
}

type PropertySpec

type PropertySpec struct {
	Kind        string   `json:"kind"`
	Group       string   `json:"group"`
	Label       string   `json:"label"`
	Required    bool     `json:"required"`
	Type        string   `json:"type"`
	JavaType    string   `json:"javaType"`
	Enum        []string `json:"enum"`
	Deprecated  bool     `json:"deprecated"`
	Secret      bool     `json:"secret"`
	Description string   `json:"description"`
}

PropertySpec contains the metadata for an individual property on a component or endpoint