# Functions
Discovery returns an object tree representing the status of a Cluster API cluster.
GetAllV1Beta2Conditions returns the other conditions (all the conditions except ready) for an object, if defined.
GetAvailableV1Beta2Condition returns the AvailableCondition for an object, if defined.
GetGroupItems returns the list of names for the objects included in a group object.
GetGroupItemsAvailableCounter returns the number of available objects in the group, e.g.
GetGroupItemsReadyCounter returns the number of ready objects in the group, e.g.
GetGroupItemsUpToDateCounter returns the number of up-to-date objects in the group, e.g.
GetMachineUpToDateV1Beta2Condition returns machine's UpToDate condition, if defined.
GetMetaName returns the object meta name that should be used for the object in the presentation layer, if defined.
GetObjectContract returns which Cluster API contract an unstructured object abides to.
GetOtherConditions returns the other conditions (all the conditions except ready) for an object, if defined.
GetReadyCondition returns the ReadyCondition for an object, if defined.
GetReadyV1Beta2Condition returns the ReadyCondition for an object, if defined.
GetZOrder return the zOrder of the object.
IsGroupingObject returns true in case the object is responsible to trigger the grouping action when adding the object's children.
IsGroupObject returns true if the object is the result of a grouping operation, and thus the object is representing group of sibling object, e.g.
IsShowConditionsObject returns true if the presentation layer should show all the conditions for the object.
IsVirtualObject returns true if the object does not correspond to any real object, but instead it is a virtual object introduced to provide a better representation of the cluster status.
NewObjectTree creates a new object tree with the given root and options.
ObjectReferenceObject returns a new object referenced by the objectRef.
VirtualObject returns a new virtual object.
# Constants
GroupingObjectAnnotation is an annotation that should be applied to a node in order to trigger the grouping action when adding the node's children.
GroupItemsAnnotation contains the list of names for the objects included in a group object.
GroupItemsAvailableCounter contains the number of available objects in the group, e.g.
GroupItemsReadyCounter contains the number of ready objects in the group, e.g.
GroupItemsSeparator is the separator used in the GroupItemsAnnotation.
GroupItemsUpToDateCounter contains the number of up-to-date objects in the group, e.g.
GroupObjectAnnotation is an annotation that documents that a node is the result of a grouping operation, and thus the node is representing group of sibling nodes, e.g.
ObjectContractAnnotation is added to unstructured objects to track which Cluster API contract those objects abide to.
ObjectMetaNameAnnotation contains the meta name that should be used for the object in the presentation layer, e.g.
ObjectZOrderAnnotation contains an integer that defines the sorting of child objects when the object tree is printed.
ShowObjectConditionsAnnotation documents that the presentation layer should show all the conditions for the object.
VirtualObjectAnnotation documents that the object does not correspond to any real object, but instead is a virtual object introduced to provide a better representation of the cluster status, e.g.
# Structs
DiscoverOptions define options for the discovery process.
NodeObject represent a node in the tree which doesn't correspond to Cluster, MachineDeployment, Machine etc.
NodeObjectV1Beta2Status is the v1Beta2 status of a node object.
NodeStatus is the status of a node object.
ObjectTree defines an object tree representing the status of a Cluster API cluster.
ObjectTreeOptions defines the options for an ObjectTree.
# Interfaces
AddObjectOption define an option for the ObjectTree Add operation.
# Type aliases
The GroupingObject option makes this node responsible of triggering the grouping action when adding the node's children.
The NoEcho options defines if the object should be hidden if the object's ready condition has the same Status, Severity and Reason of the parent's object ready condition (it is an echo).
The ObjectMetaName option defines the meta name that should be used for the object in the presentation layer, e.g.
The ZOrder options defines the sorting of child objects when the tree is printed.