apis

Documentation

Index

• type Component
• type ComponentBase
• type Policy
• type PolicyBase
• type Trait
• type TraitBase
• type TypedApplication
• type WorkflowStep
• type WorkflowStepBase
• type WorkflowSubStepBase

Types

type Component

type Component interface {
	ComponentName() string
	DefType() string
	Build() common.ApplicationComponent
	GetTrait(typ string) Trait
	GetAllTraits() []Trait
	Validate() error
}

type ComponentBase

type ComponentBase struct {
	Name      string
	Type      string
	DependsOn []string
	Inputs    common.StepInputs
	Outputs   common.StepOutputs
	Traits    []Trait
}

type Policy

type Policy interface {
	PolicyName() string
	DefType() string
	Build() v1beta1.AppPolicy
	Validate() error
}

type PolicyBase

type PolicyBase struct {
	Name string
	Type string
}

type Trait

type Trait interface {
	DefType() string
	Build() common.ApplicationTrait
	Validate() error
}

type TraitBase

type TraitBase struct {
	Type string
}

type TypedApplication

type TypedApplication interface {
	Name(name string) TypedApplication
	Namespace(namespace string) TypedApplication
	Labels(labels map[string]string) TypedApplication
	Annotations(annotations map[string]string) TypedApplication

	SetWorkflowMode(steps, subSteps common.WorkflowMode) TypedApplication
	SetComponents(components ...Component) TypedApplication
	SetWorkflowSteps(steps ...WorkflowStep) TypedApplication
	SetPolicies(policies ...Policy) TypedApplication

	GetNamespace() string
	GetLabels() map[string]string
	GetAnnotations() map[string]string
	GetComponentByName(name string) Component
	GetComponentsByType(typ string) []Component
	GetWorkflowStepByName(name string) WorkflowStep
	GetWorkflowStepsByType(typ string) []WorkflowStep
	GetPolicyByName(name string) Policy
	GetPoliciesByType(typ string) []Policy

	Build() v1beta1.Application
	ToYAML() (string, error)
	Validate() error
}

type WorkflowStep

type WorkflowStep interface {
	WorkflowStepName() string
	DefType() string
	Build() v1beta1.WorkflowStep
	Validate() error
}

type WorkflowStepBase

type WorkflowStepBase struct {
	Name      string
	Type      string
	Meta      *common.WorkflowStepMeta
	SubSteps  []WorkflowStep
	If        string
	Timeout   string
	DependsOn []string
	Inputs    common.StepInputs
	Outputs   common.StepOutputs
}

type WorkflowSubStepBase

type WorkflowSubStepBase struct {
	Name      string
	Type      string
	Meta      *common.WorkflowStepMeta
	If        string
	Timeout   string
	DependsOn []string
	Inputs    common.StepInputs
	Outputs   common.StepOutputs
}