latest

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2017 License: Apache-2.0, Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package latest defines the default output serializations that code should use and imports the required schemas. It also ensures all previously known and supported API versions are available for conversion. Consumers may import this package in lieu of importing individual versions.

Index

Constants

This section is empty.

Variables

View Source
var (

	// Group is a shortcut to allGroups.Group.
	Group = allGroups.Group
	// RegisterGroup is a shortcut to allGroups.RegisterGroup.
	RegisterGroup = allGroups.RegisterGroup
	// GroupOrDie is a shortcut to allGroups.GroupOrDie.
	GroupOrDie = allGroups.GroupOrDie
	// AllPreferredGroupVersions returns the preferred versions of all
	// registered groups in the form of "group1/version1,group2/version2,..."
	AllPreferredGroupVersions = allGroups.AllPreferredGroupVersions
	// IsRegistered is a shortcut to allGroups.IsRegistered.
	IsRegistered = allGroups.IsRegistered
)
View Source
var ExternalVersions = []unversioned.GroupVersion{
	{Group: "", Version: "v1"},
}

ExternalVersions is a list of all external versions for this API group in order of most preferred to least preferred

Functions

This section is empty.

Types

type GroupMeta

type GroupMeta struct {
	// GroupVersion represents the current external default version of the group.
	GroupVersion unversioned.GroupVersion

	// GroupVersions is Group + Versions. This is to avoid string concatenation
	// in many places.
	GroupVersions []unversioned.GroupVersion

	// Codec is the default codec for serializing output that should use
	// the latest supported version.  Use this Codec when writing to
	// disk, a data store that is not dynamically versioned, or in tests.
	// This codec can decode any object that Kubernetes is aware of.
	Codec runtime.Codec

	// SelfLinker can set or get the SelfLink field of all API types.
	// TODO: when versioning changes, make this part of each API definition.
	// TODO(lavalamp): Combine SelfLinker & ResourceVersioner interfaces, force all uses
	// to go through the InterfacesFor method below.
	SelfLinker runtime.SelfLinker

	// RESTMapper provides the default mapping between REST paths and the objects declared in api.Scheme and all known
	// Kubernetes versions.
	RESTMapper meta.RESTMapper

	// InterfacesFor returns the default Codec and ResourceVersioner for a given version
	// or an error if the version is not known.
	InterfacesFor func(version unversioned.GroupVersion) (*meta.VersionInterfaces, error)
}

GroupMeta stores the metadata of a group, such as the latest supported version.

type GroupMetaMap

type GroupMetaMap map[string]*GroupMeta

GroupMetaMap is a map between group names and their metadata.

func (GroupMetaMap) AllPreferredGroupVersions

func (g GroupMetaMap) AllPreferredGroupVersions() string

AllPreferredGroupVersions returns the preferred versions of all registered groups in the form of "group1/version1,group2/version2,..."

func (GroupMetaMap) Group

func (g GroupMetaMap) Group(group string) (*GroupMeta, error)

Group returns the metadata of a group if the gruop is registered, otherwise an erorr is returned.

func (GroupMetaMap) GroupOrDie

func (g GroupMetaMap) GroupOrDie(group string) *GroupMeta

TODO: This is an expedient function, because we don't check if a Group is supported throughout the code base. We will abandon this function and checking the error returned by the Group() function.

func (GroupMetaMap) IsRegistered

func (g GroupMetaMap) IsRegistered(group string) bool

IsRegistered takes a string and determines if it's one of the registered groups

func (GroupMetaMap) RegisterGroup

func (g GroupMetaMap) RegisterGroup(groupMeta GroupMeta) error

RegisterGroup registers a group to GroupMetaMap.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL