api

Documentation

Index

• type Group
  • func (f *Group) SetTemplateDefaults() error
• type Kind
  • func (f *Kind) SetTemplateDefaults() error
• type KindLatest
  • func (f *KindLatest) SetTemplateDefaults() error
• type KindUpdater
  • func (f *KindUpdater) GetCodeFragments() machinery.CodeFragmentsMap
  • func (*KindUpdater) GetIfExistsAction() machinery.IfExistsAction
  • func (f *KindUpdater) GetMarkers() []machinery.Marker
  • func (f *KindUpdater) GetPath() string
• type Types
  • func (*Types) GetFuncMap() template.FuncMap
  • func (f *Types) SetTemplateDefaults() error

Types

type Group

type Group struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
}

Group scaffolds the file that defines the registration methods for a certain group and version.

func (*Group) SetTemplateDefaults

func (f *Group) SetTemplateDefaults() error

type Kind

type Kind struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
}

Kind scaffolds the file that defines specific information related to kind regardless of the API version.

func (*Kind) SetTemplateDefaults

func (f *Kind) SetTemplateDefaults() error

type KindLatest

type KindLatest struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
	machinery.RepositoryMixin

	PackageName string
}

KindLatest scaffolds the file that defines specific information related to the latest API version of a specific kind.

func (*KindLatest) SetTemplateDefaults

func (f *KindLatest) SetTemplateDefaults() error

type KindUpdater

type KindUpdater struct {
	machinery.TemplateMixin
	machinery.MultiGroupMixin
	machinery.BoilerplateMixin
	machinery.ResourceMixin
	machinery.RepositoryMixin
}

KindUpdater updates the file with any new version information.

func (*KindUpdater) GetCodeFragments

func (f *KindUpdater) GetCodeFragments() machinery.CodeFragmentsMap

GetCodeFragments implements file.Inserter interface.

func (*KindUpdater) GetIfExistsAction

func (*KindUpdater) GetIfExistsAction() machinery.IfExistsAction

GetIfExistsAction implements file.Builder interface.

func (*KindUpdater) GetMarkers

func (f *KindUpdater) GetMarkers() []machinery.Marker

GetMarkers implements file.Inserter interface.

func (*KindUpdater) GetPath

func (f *KindUpdater) GetPath() string

GetPath implements file.Builder interface.

type Types

type Types struct {
	machinery.TemplateMixin
	machinery.BoilerplateMixin
	machinery.RepositoryMixin
	machinery.ResourceMixin

	// input fields
	Builder kinds.WorkloadBuilder
}

Types scaffolds a workload's API type.

func (*Types) GetFuncMap

func (*Types) GetFuncMap() template.FuncMap

func (*Types) SetTemplateDefaults

func (f *Types) SetTemplateDefaults() error

SetTemplateDefaults implements file.Template.