componentcfg

Documentation

Index

• Constants
• Variables
• func GetComponentsMapFromKeysList(keys []string) map[string]bool
• func GetEntriesMapOfComponentFromKeysList(component string, runtype apricotpb.RunType, rolename string, keys []string) map[string]bool
• func GetLatestTimestamp(keys []string, p *Query) (timestamp string, err error)
• func GetTimestampInFormat(timestamp string, timeFormat string) (string, error)
• func IsInputSingleValidWord(input string) bool
• func IsStringValidEntriesQueryPath(input string) bool
• func IsStringValidQueryPathWithOptionalTimestamp(input string) bool
• type EntriesQuery
  • func NewEntriesQuery(path string) (p *EntriesQuery, err error)
• type Query
  • func NewQuery(path string) (p *Query, err error)
  • func (p *Query) AbsoluteRaw() string
  • func (p *Query) AbsoluteWithoutTimestamp() string
  • func (p *Query) Path() string
  • func (p *Query) Raw() string
  • func (p *Query) WithFallbackRoleName() *Query
  • func (p *Query) WithFallbackRunType() *Query
  • func (p *Query) WithoutTimestamp() string

Constants

const (
	SEPARATOR      = "/"
	SEPARATOR_RUNE = '/'
)

const (
	FALLBACK_RUNTYPE = apricotpb.RunType_ANY

	FALLBACK_ROLENAME = "any"
)

const (
	ConfigComponentsPath = "o2/components/"
)

Variables

var (
	E_BAD_KEY = errors.New("bad component configuration key format")
)

Functions

func GetComponentsMapFromKeysList

func GetComponentsMapFromKeysList(keys []string) map[string]bool

keys must be a slice containing all the full keys in /o2/components

func GetEntriesMapOfComponentFromKeysList

func GetEntriesMapOfComponentFromKeysList(component string, runtype apricotpb.RunType, rolename string, keys []string) map[string]bool

func GetLatestTimestamp

func GetLatestTimestamp(keys []string, p *Query) (timestamp string, err error)

Method to return the latest timestamp for a specified component & entry If no keys were passed an error and code exit 3 will be returned

func GetTimestampInFormat

func GetTimestampInFormat(timestamp string, timeFormat string) (string, error)

Method to parse a timestamp in the specified format

func IsInputSingleValidWord

func IsInputSingleValidWord(input string) bool

Checks whether the input string is a valid Consul path element on its own

func IsStringValidEntriesQueryPath

func IsStringValidEntriesQueryPath(input string) bool

func IsStringValidQueryPathWithOptionalTimestamp

func IsStringValidQueryPathWithOptionalTimestamp(input string) bool

Types

type EntriesQuery

type EntriesQuery struct {
	Component string
	RunType   apricotpb.RunType
	RoleName  string
}

func NewEntriesQuery

func NewEntriesQuery(path string) (p *EntriesQuery, err error)

type Query

type Query struct {
	Component string
	RunType   apricotpb.RunType
	RoleName  string
	EntryKey  string
	Timestamp string
}

func NewQuery

func NewQuery(path string) (p *Query, err error)

func (*Query) AbsoluteRaw

func (p *Query) AbsoluteRaw() string

func (*Query) AbsoluteWithoutTimestamp

func (p *Query) AbsoluteWithoutTimestamp() string

func (*Query) Path

func (p *Query) Path() string

func (*Query) Raw

func (p *Query) Raw() string

func (*Query) WithFallbackRoleName

func (p *Query) WithFallbackRoleName() *Query

func (*Query) WithFallbackRunType

func (p *Query) WithFallbackRunType() *Query

func (*Query) WithoutTimestamp

func (p *Query) WithoutTimestamp() string