common

Documentation

Index

• type Aliases
  • func (a Aliases) HasAlias(alias string) bool
• type Annotations
  • func (a Annotations) MatchesAnnotationSelectors(selectors []string) bool
• type Tags
  • func (t Tags) HasAnyTag(tags Tags) bool
  • func (t Tags) HasTag(tag string) bool
  • func (t Tags) PreviewString() string
  • func (t Tags) String() string
• type Visibility
  • func (v Visibility) IsHidden() bool
  • func (v Visibility) IsInternal() bool
  • func (v Visibility) IsPrivate() bool
  • func (v Visibility) IsPublic() bool
  • func (v Visibility) Level() int
  • func (v Visibility) NewPointer() *Visibility
  • func (v Visibility) String() string

Types

type Aliases

type Aliases []string

Alternate names that can be used to reference the executable in the CLI.

func (Aliases) HasAlias

func (a Aliases) HasAlias(alias string) bool

type Annotations

type Annotations map[string]string

A map of arbitrary string key/value metadata attached to the object. Annotations are intended for use by external tools and integrations to store system metadata. Unlike tags, annotations are not used for filtering or display in the Flow UI - treat them as opaque state. Keys should be namespaced (e.g. `my-tool.example.com/state`) to avoid collisions between tools.

func (Annotations) MatchesAnnotationSelectors

func (a Annotations) MatchesAnnotationSelectors(selectors []string) bool

MatchesAnnotationSelectors reports whether the annotations satisfy every selector. Each selector is either "key" (matches if the key is present, regardless of value) or "key=value" (matches if the key is present with the exact value). Empty or whitespace-only selectors are ignored. An empty selector list always matches. Semantics are AND across selectors (all must match).

type Tags

type Tags []string

A list of tags. Tags can be used with list commands to filter returned data.

func (Tags) HasAnyTag

func (t Tags) HasAnyTag(tags Tags) bool

func (Tags) HasTag

func (t Tags) HasTag(tag string) bool

func (Tags) PreviewString

func (t Tags) PreviewString() string

func (Tags) String

func (t Tags) String() string

type Visibility

type Visibility string

const VisibilityHidden Visibility = "hidden"

const VisibilityInternal Visibility = "internal"

const VisibilityPrivate Visibility = "private"

const VisibilityPublic Visibility = "public"

func (Visibility) IsHidden

func (v Visibility) IsHidden() bool

func (Visibility) IsInternal

func (v Visibility) IsInternal() bool

func (Visibility) IsPrivate

func (v Visibility) IsPrivate() bool

func (Visibility) IsPublic

func (v Visibility) IsPublic() bool

func (Visibility) Level

func (v Visibility) Level() int

Level returns the hierarchical level of the visibility for filtering comparisons. Hierarchy (most to least visible): 1: public, 2: private, 3: internal, 4: hidden Defaults to private when unknown.

func (Visibility) NewPointer

func (v Visibility) NewPointer() *Visibility

func (Visibility) String

func (v Visibility) String() string