Documentation ¶
Index ¶
- type Base
- type Edgeable
- type Groupable
- func (obj *Groupable) AutoGroupMeta() *engine.AutoGroupMeta
- func (obj *Groupable) GetGroup() []engine.GroupableRes
- func (obj *Groupable) GroupCmp(res engine.GroupableRes) error
- func (obj *Groupable) GroupRes(res engine.GroupableRes) error
- func (obj *Groupable) IsGrouped() bool
- func (obj *Groupable) SetGroup(grouped []engine.GroupableRes)
- func (obj *Groupable) SetGrouped(b bool)
- type Kinded
- type Meta
- type Named
- type Recvable
- type Refreshable
- type Sendable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Base ¶
Base contains all the minimum necessary structs to build a resource. It should be used as a starting point to avoid re-implementing the straightforward methods.
type Edgeable ¶
type Edgeable struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Edgeable contains a general implementation with some of the properties and methods needed to support autoedges on resources. It may be used as a start point to avoid re-implementing the straightforward methods.
func (*Edgeable) AutoEdgeMeta ¶
func (obj *Edgeable) AutoEdgeMeta() *engine.AutoEdgeMeta
AutoEdgeMeta lets you get or set meta params for the automatic edges trait.
type Groupable ¶
type Groupable struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Groupable contains a general implementation with most of the properties and methods needed to support autogrouping on resources. It may be used as a starting point to avoid re-implementing the straightforward methods.
func (*Groupable) AutoGroupMeta ¶
func (obj *Groupable) AutoGroupMeta() *engine.AutoGroupMeta
AutoGroupMeta lets you get or set meta params for the automatic grouping trait.
func (*Groupable) GetGroup ¶
func (obj *Groupable) GetGroup() []engine.GroupableRes
GetGroup returns everyone grouped inside me.
func (*Groupable) GroupCmp ¶
func (obj *Groupable) GroupCmp(res engine.GroupableRes) error
GroupCmp compares two resources and decides if they're suitable for grouping. You'll probably want to override this method when implementing a resource... This base implementation assumes not, so override me!
func (*Groupable) GroupRes ¶
func (obj *Groupable) GroupRes(res engine.GroupableRes) error
GroupRes groups resource argument (res) into self.
func (*Groupable) SetGroup ¶
func (obj *Groupable) SetGroup(grouped []engine.GroupableRes)
SetGroup sets the grouped resources into me.
func (*Groupable) SetGrouped ¶
SetGrouped sets a flag to tell if we are grouped.
type Kinded ¶
type Kinded struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Kinded contains a general implementation of the properties and methods needed to support the resource kind. It should be used as a starting point to avoid re-implementing the straightforward kind methods.
type Meta ¶
type Meta struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Meta contains a general implementation of the properties and methods needed to support meta parameters. It should be used as a starting point to avoid re-implementing the straightforward meta methods.
func (*Meta) MetaParams ¶
func (obj *Meta) MetaParams() *engine.MetaParams
MetaParams lets you get or set meta params for this trait.
type Named ¶
type Named struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Named contains a general implementation of the properties and methods needed to support named resources. It should be used as a starting point to avoid re-implementing the straightforward name methods.
type Recvable ¶
type Recvable struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Recvable contains a general implementation with some of the properties and methods needed to implement receiving from resources.
type Refreshable ¶
type Refreshable struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Refreshable functions as flag storage for resources to signal that they support receiving refresh notifications, and what that value is. These are commonly used to send information that some aspect of the state is invalid due to an unlinked change. The canonical example is a svc resource that needs reloading after a configuration file changes.
func (*Refreshable) Refresh ¶
func (obj *Refreshable) Refresh() bool
Refresh returns the refresh notification state.
func (*Refreshable) SetRefresh ¶
func (obj *Refreshable) SetRefresh(b bool)
SetRefresh sets the refresh notification state.
type Sendable ¶
type Sendable struct { // Bug5819 works around issue https://github.com/golang/go/issues/5819 Bug5819 interface{} // XXX: workaround // contains filtered or unexported fields }
Sendable contains a general implementation with some of the properties and methods needed to implement sending from resources. You'll need to implement the Sends method, and call the Send method in CheckApply via the Init API.
func (*Sendable) Send ¶
Send is used to send a struct in CheckApply. This is typically wrapped in the resource API and consumed that way.