common

Documentation

Overview

Package common serves as a catch-all package for sharing types between O² Control components.

Index

• func GetEnvironmentIdFromLabelerType(labeler Labeler) uid.ID
• func GetValueFromLabelerType(labeler Labeler, key string) string
• type CommandInfo
  • func (m *CommandInfo) Copy() *CommandInfo
  • func (m *CommandInfo) Equals(other *CommandInfo) (response bool)
  • func (m *CommandInfo) GetArguments() []string
  • func (m *CommandInfo) GetEnv() []string
  • func (m *CommandInfo) GetShell() bool
  • func (m *CommandInfo) GetUser() string
  • func (m *CommandInfo) GetValue() string
  • func (m *CommandInfo) Reset()
  • func (m *CommandInfo) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
  • func (m *CommandInfo) UpdateFrom(n *CommandInfo)
• type Labeler
• type LogTaskOutput
• type TaskCommandInfo

Functions

func GetEnvironmentIdFromLabelerType

func GetEnvironmentIdFromLabelerType(labeler Labeler) uid.ID

func GetValueFromLabelerType

func GetValueFromLabelerType(labeler Labeler, key string) string

Types

type CommandInfo

type CommandInfo struct {
	Env       []string `json:"env,omitempty" yaml:"env,omitempty"`
	Shell     *bool    `json:"shell,omitempty" yaml:"shell,omitempty"`
	Value     *string  `json:"value,omitempty" yaml:"value,omitempty"`
	User      *string  `json:"user,omitempty" yaml:"user,omitempty"`
	Arguments []string `json:"arguments,omitempty" yaml:"arguments,omitempty"`
	Stdout    *string  `json:"stdout,omitempty" yaml:"stdout,omitempty"`
	Stderr    *string  `json:"stderr,omitempty" yaml:"stderr,omitempty"`
}

func (*CommandInfo) Copy

func (m *CommandInfo) Copy() *CommandInfo

func (*CommandInfo) Equals

func (m *CommandInfo) Equals(other *CommandInfo) (response bool)

func (*CommandInfo) GetArguments

func (m *CommandInfo) GetArguments() []string

func (*CommandInfo) GetEnv

func (m *CommandInfo) GetEnv() []string

func (*CommandInfo) GetShell

func (m *CommandInfo) GetShell() bool

func (*CommandInfo) GetUser

func (m *CommandInfo) GetUser() string

func (*CommandInfo) GetValue

func (m *CommandInfo) GetValue() string

func (*CommandInfo) Reset

func (m *CommandInfo) Reset()

func (*CommandInfo) UnmarshalYAML

func (m *CommandInfo) UnmarshalYAML(unmarshal func(interface{}) error) (err error)

func (*CommandInfo) UpdateFrom

func (m *CommandInfo) UpdateFrom(n *CommandInfo)

type Labeler

type Labeler interface {
	GetLabels() map[string]string
}

type LogTaskOutput

type LogTaskOutput int

type TaskCommandInfo

type TaskCommandInfo struct {
	CommandInfo
	ControlPort uint64                  `json:"controlPort"`
	ControlMode controlmode.ControlMode `json:"controlMode"`

	// Only applies to hooks and basic tasks
	Timeout time.Duration `json:"timeout,omitempty"`
}