fieldmeta

Documentation

Index

• Constants
• type FieldMeta
  • func (fm *FieldMeta) Read(n *yaml.RNode) error
  • func (fm *FieldMeta) Write(n *yaml.RNode) error
• type FieldValueType
  • func (it FieldValueType) String() string
  • func (it FieldValueType) Tag() string
  • func (it FieldValueType) TagForValue(value string) string
  • func (it FieldValueType) Validate(value string) error
• type PartialFieldSetter
• type XKustomize

Constants

const (
	// String defines a string flag
	String FieldValueType = "string"
	// Bool defines a bool flag
	Bool = "boolean"
	// Int defines an int flag
	Int = "integer"
)

Types

type FieldMeta

type FieldMeta struct {
	Schema spec.Schema

	Extensions XKustomize
}

FieldMeta contains metadata that may be attached to fields as comments

func (*FieldMeta) Read

func (fm *FieldMeta) Read(n *yaml.RNode) error

Read reads the FieldMeta from a node

func (*FieldMeta) Write

func (fm *FieldMeta) Write(n *yaml.RNode) error

Write writes the FieldMeta to a node

type FieldValueType

type FieldValueType string

FieldValueType defines the type of input to register

func (FieldValueType) String

func (it FieldValueType) String() string

func (FieldValueType) Tag

func (it FieldValueType) Tag() string

func (FieldValueType) TagForValue

func (it FieldValueType) TagForValue(value string) string

func (FieldValueType) Validate

func (it FieldValueType) Validate(value string) error

type PartialFieldSetter

type PartialFieldSetter struct {
	// Name is the name of this setter.
	Name string `yaml:"name" json:"name"`

	// Value is the current value that has been set.
	Value string `yaml:"value" json:"value"`
}

PartialFieldSetter defines how to set part of a field rather than the full field value. e.g. the tag part of an image field

type XKustomize

type XKustomize struct {
	SetBy               string               `yaml:"setBy,omitempty" json:"setBy,omitempty"`
	PartialFieldSetters []PartialFieldSetter `yaml:"partialSetters,omitempty" json:"partialSetters,omitempty"`
	FieldSetter         *PartialFieldSetter  `yaml:"setter,omitempty" json:"setter,omitempty"`
}