apimachinery: k8s.io/apimachinery/pkg/api/meta Index | Files | Directories

package meta

import "k8s.io/apimachinery/pkg/api/meta"

Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API

TODO: move everything in this file to pkg/api/rest

Index

Package Files

doc.go errors.go firsthit_restmapper.go help.go interfaces.go lazy.go meta.go multirestmapper.go priority.go restmapper.go

Constants

const (
    AnyGroup    = "*"
    AnyVersion  = "*"
    AnyResource = "*"
    AnyKind     = "*"
)

Variables

var RESTScopeNamespace = &restScope{
    name: RESTScopeNameNamespace,
}
var RESTScopeRoot = &restScope{
    name: RESTScopeNameRoot,
}

func Accessor Uses

func Accessor(obj interface{}) (metav1.Object, error)

Accessor takes an arbitrary object pointer and returns meta.Interface. obj must be a pointer to an API type. An error is returned if the minimum required fields are missing. Fields that are not required return the default value and are a no-op if set.

func AsPartialObjectMetadata Uses

func AsPartialObjectMetadata(m metav1.Object) *metav1.PartialObjectMetadata

AsPartialObjectMetadata takes the metav1 interface and returns a partial object. TODO: consider making this solely a conversion action.

func CommonAccessor Uses

func CommonAccessor(obj interface{}) (metav1.Common, error)

CommonAccessor returns a Common interface for the provided object or an error if the object does not provide List.

func EachListItem Uses

func EachListItem(obj runtime.Object, fn func(runtime.Object) error) error

EachListItem invokes fn on each runtime.Object in the list. Any error immediately terminates the loop.

func ExtractList Uses

func ExtractList(obj runtime.Object) ([]runtime.Object, error)

ExtractList returns obj's Items element as an array of runtime.Objects. Returns an error if obj is not a List type (does not have an Items member).

func GetItemsPtr Uses

func GetItemsPtr(list runtime.Object) (interface{}, error)

GetItemsPtr returns a pointer to the list object's Items member. If 'list' doesn't have an Items member, it's not really a list type and an error will be returned. This function will either return a pointer to a slice, or an error, but not both. TODO: this will be replaced with an interface in the future

func IsAmbiguousError Uses

func IsAmbiguousError(err error) bool

func IsListType Uses

func IsListType(obj runtime.Object) bool

IsListType returns true if the provided Object has a slice called Items. TODO: Replace the code in this check with an interface comparison by

creating and enforcing that lists implement a list accessor.

func IsNoMatchError Uses

func IsNoMatchError(err error) bool

func LenList Uses

func LenList(list runtime.Object) int

LenList returns the length of this list or 0 if it is not a list.

func SetList Uses

func SetList(list runtime.Object, objects []runtime.Object) error

SetList sets the given list object's Items member have the elements given in objects. Returns an error if list is not a List type (does not have an Items member), or if any of the objects are not of the right type.

func UnsafeGuessKindToResource Uses

func UnsafeGuessKindToResource(kind schema.GroupVersionKind) (schema.GroupVersionResource, schema.GroupVersionResource)

UnsafeGuessKindToResource converts Kind to a resource name. Broken. This method only "sort of" works when used outside of this package. It assumes that Kinds and Resources match and they aren't guaranteed to do so.

type AmbiguousKindError Uses

type AmbiguousKindError struct {
    PartialKind schema.GroupVersionKind

    MatchingResources []schema.GroupVersionResource
    MatchingKinds     []schema.GroupVersionKind
}

AmbiguousKindError is returned if the RESTMapper finds multiple matches for a kind

func (*AmbiguousKindError) Error Uses

func (e *AmbiguousKindError) Error() string

type AmbiguousResourceError Uses

type AmbiguousResourceError struct {
    PartialResource schema.GroupVersionResource

    MatchingResources []schema.GroupVersionResource
    MatchingKinds     []schema.GroupVersionKind
}

AmbiguousResourceError is returned if the RESTMapper finds multiple matches for a resource

func (*AmbiguousResourceError) Error Uses

func (e *AmbiguousResourceError) Error() string

type DefaultRESTMapper Uses

type DefaultRESTMapper struct {
    // contains filtered or unexported fields
}

DefaultRESTMapper exposes mappings between the types defined in a runtime.Scheme. It assumes that all types defined the provided scheme can be mapped with the provided MetadataAccessor and Codec interfaces.

The resource name of a Kind is defined as the lowercase, English-plural version of the Kind string. When converting from resource to Kind, the singular version of the resource name is also accepted for convenience.

TODO: Only accept plural for some operations for increased control? (`get pod bar` vs `get pods bar`)

func NewDefaultRESTMapper Uses

func NewDefaultRESTMapper(defaultGroupVersions []schema.GroupVersion) *DefaultRESTMapper

NewDefaultRESTMapper initializes a mapping between Kind and APIVersion to a resource name and back based on the objects in a runtime.Scheme and the Kubernetes API conventions. Takes a group name, a priority list of the versions to search when an object has no default version (set empty to return an error), and a function that retrieves the correct metadata for a given version.

func (*DefaultRESTMapper) Add Uses

func (m *DefaultRESTMapper) Add(kind schema.GroupVersionKind, scope RESTScope)

func (*DefaultRESTMapper) AddSpecific Uses

func (m *DefaultRESTMapper) AddSpecific(kind schema.GroupVersionKind, plural, singular schema.GroupVersionResource, scope RESTScope)

func (*DefaultRESTMapper) KindFor Uses

func (m *DefaultRESTMapper) KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error)

func (*DefaultRESTMapper) KindsFor Uses

func (m *DefaultRESTMapper) KindsFor(input schema.GroupVersionResource) ([]schema.GroupVersionKind, error)

func (*DefaultRESTMapper) RESTMapping Uses

func (m *DefaultRESTMapper) RESTMapping(gk schema.GroupKind, versions ...string) (*RESTMapping, error)

RESTMapping returns a struct representing the resource path and conversion interfaces a RESTClient should use to operate on the provided group/kind in order of versions. If a version search order is not provided, the search order provided to DefaultRESTMapper will be used to resolve which version should be used to access the named group/kind.

func (*DefaultRESTMapper) RESTMappings Uses

func (m *DefaultRESTMapper) RESTMappings(gk schema.GroupKind, versions ...string) ([]*RESTMapping, error)

RESTMappings returns the RESTMappings for the provided group kind. If a version search order is not provided, the search order provided to DefaultRESTMapper will be used.

func (*DefaultRESTMapper) ResourceFor Uses

func (m *DefaultRESTMapper) ResourceFor(resource schema.GroupVersionResource) (schema.GroupVersionResource, error)

func (*DefaultRESTMapper) ResourceSingularizer Uses

func (m *DefaultRESTMapper) ResourceSingularizer(resourceType string) (string, error)

ResourceSingularizer implements RESTMapper It converts a resource name from plural to singular (e.g., from pods to pod)

func (*DefaultRESTMapper) ResourcesFor Uses

func (m *DefaultRESTMapper) ResourcesFor(input schema.GroupVersionResource) ([]schema.GroupVersionResource, error)

func (*DefaultRESTMapper) String Uses

func (m *DefaultRESTMapper) String() string

type FirstHitRESTMapper Uses

type FirstHitRESTMapper struct {
    MultiRESTMapper
}

FirstHitRESTMapper is a wrapper for multiple RESTMappers which returns the first successful result for the singular requests

func (FirstHitRESTMapper) KindFor Uses

func (m FirstHitRESTMapper) KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error)

func (FirstHitRESTMapper) RESTMapping Uses

func (m FirstHitRESTMapper) RESTMapping(gk schema.GroupKind, versions ...string) (*RESTMapping, error)

RESTMapping provides the REST mapping for the resource based on the kind and version. This implementation supports multiple REST schemas and return the first match.

func (FirstHitRESTMapper) ResourceFor Uses

func (m FirstHitRESTMapper) ResourceFor(resource schema.GroupVersionResource) (schema.GroupVersionResource, error)

func (FirstHitRESTMapper) String Uses

func (m FirstHitRESTMapper) String() string

type List Uses

type List metav1.ListInterface

List lets you work with list metadata from any of the versioned or internal API objects. Attempting to set or retrieve a field on an object that does not support that field will be a no-op and return a default value.

func ListAccessor Uses

func ListAccessor(obj interface{}) (List, error)

ListAccessor returns a List interface for the provided object or an error if the object does not provide List. IMPORTANT: Objects are NOT a superset of lists. Do not use this check to determine whether an object *is* a List.

type ListMetaAccessor Uses

type ListMetaAccessor interface {
    GetListMeta() List
}

type MetadataAccessor Uses

type MetadataAccessor interface {
    APIVersion(obj runtime.Object) (string, error)
    SetAPIVersion(obj runtime.Object, version string) error

    Kind(obj runtime.Object) (string, error)
    SetKind(obj runtime.Object, kind string) error

    Namespace(obj runtime.Object) (string, error)
    SetNamespace(obj runtime.Object, namespace string) error

    Name(obj runtime.Object) (string, error)
    SetName(obj runtime.Object, name string) error

    GenerateName(obj runtime.Object) (string, error)
    SetGenerateName(obj runtime.Object, name string) error

    UID(obj runtime.Object) (types.UID, error)
    SetUID(obj runtime.Object, uid types.UID) error

    SelfLink(obj runtime.Object) (string, error)
    SetSelfLink(obj runtime.Object, selfLink string) error

    Labels(obj runtime.Object) (map[string]string, error)
    SetLabels(obj runtime.Object, labels map[string]string) error

    Annotations(obj runtime.Object) (map[string]string, error)
    SetAnnotations(obj runtime.Object, annotations map[string]string) error

    Continue(obj runtime.Object) (string, error)
    SetContinue(obj runtime.Object, c string) error

    runtime.ResourceVersioner
}

MetadataAccessor lets you work with object and list metadata from any of the versioned or internal API objects. Attempting to set or retrieve a field on an object that does not support that field (Name, UID, Namespace on lists) will be a no-op and return a default value.

MetadataAccessor exposes Interface in a way that can be used with multiple objects.

func NewAccessor Uses

func NewAccessor() MetadataAccessor

NewAccessor returns a MetadataAccessor that can retrieve or manipulate resource version on objects derived from core API metadata concepts.

type MultiRESTMapper Uses

type MultiRESTMapper []RESTMapper

MultiRESTMapper is a wrapper for multiple RESTMappers.

func (MultiRESTMapper) KindFor Uses

func (m MultiRESTMapper) KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error)

func (MultiRESTMapper) KindsFor Uses

func (m MultiRESTMapper) KindsFor(resource schema.GroupVersionResource) (gvk []schema.GroupVersionKind, err error)

func (MultiRESTMapper) RESTMapping Uses

func (m MultiRESTMapper) RESTMapping(gk schema.GroupKind, versions ...string) (*RESTMapping, error)

RESTMapping provides the REST mapping for the resource based on the kind and version. This implementation supports multiple REST schemas and return the first match.

func (MultiRESTMapper) RESTMappings Uses

func (m MultiRESTMapper) RESTMappings(gk schema.GroupKind, versions ...string) ([]*RESTMapping, error)

RESTMappings returns all possible RESTMappings for the provided group kind, or an error if the type is not recognized.

func (MultiRESTMapper) ResourceFor Uses

func (m MultiRESTMapper) ResourceFor(resource schema.GroupVersionResource) (schema.GroupVersionResource, error)

func (MultiRESTMapper) ResourceSingularizer Uses

func (m MultiRESTMapper) ResourceSingularizer(resource string) (singular string, err error)

ResourceSingularizer converts a REST resource name from plural to singular (e.g., from pods to pod) This implementation supports multiple REST schemas and return the first match.

func (MultiRESTMapper) ResourcesFor Uses

func (m MultiRESTMapper) ResourcesFor(resource schema.GroupVersionResource) ([]schema.GroupVersionResource, error)

func (MultiRESTMapper) String Uses

func (m MultiRESTMapper) String() string

type NoKindMatchError Uses

type NoKindMatchError struct {
    // GroupKind is the API group and kind that was searched
    GroupKind schema.GroupKind
    // SearchedVersions is the optional list of versions the search was restricted to
    SearchedVersions []string
}

NoKindMatchError is returned if the RESTMapper can't find any match for a kind

func (*NoKindMatchError) Error Uses

func (e *NoKindMatchError) Error() string

type NoResourceMatchError Uses

type NoResourceMatchError struct {
    PartialResource schema.GroupVersionResource
}

NoResourceMatchError is returned if the RESTMapper can't find any match for a resource

func (*NoResourceMatchError) Error Uses

func (e *NoResourceMatchError) Error() string

type PriorityRESTMapper Uses

type PriorityRESTMapper struct {
    // Delegate is the RESTMapper to use to locate all the Kind and Resource matches
    Delegate RESTMapper

    // ResourcePriority is a list of priority patterns to apply to matching resources.
    // The list of all matching resources is narrowed based on the patterns until only one remains.
    // A pattern with no matches is skipped.  A pattern with more than one match uses its
    // matches as the list to continue matching against.
    ResourcePriority []schema.GroupVersionResource

    // KindPriority is a list of priority patterns to apply to matching kinds.
    // The list of all matching kinds is narrowed based on the patterns until only one remains.
    // A pattern with no matches is skipped.  A pattern with more than one match uses its
    // matches as the list to continue matching against.
    KindPriority []schema.GroupVersionKind
}

PriorityRESTMapper is a wrapper for automatically choosing a particular Resource or Kind when multiple matches are possible

func (PriorityRESTMapper) KindFor Uses

func (m PriorityRESTMapper) KindFor(partiallySpecifiedResource schema.GroupVersionResource) (schema.GroupVersionKind, error)

KindFor finds all kinds, then passes them through the KindPriority patterns to find a single matching hit.

func (PriorityRESTMapper) KindsFor Uses

func (m PriorityRESTMapper) KindsFor(partiallySpecifiedResource schema.GroupVersionResource) (gvk []schema.GroupVersionKind, err error)

func (PriorityRESTMapper) RESTMapping Uses

func (m PriorityRESTMapper) RESTMapping(gk schema.GroupKind, versions ...string) (mapping *RESTMapping, err error)

func (PriorityRESTMapper) RESTMappings Uses

func (m PriorityRESTMapper) RESTMappings(gk schema.GroupKind, versions ...string) ([]*RESTMapping, error)

func (PriorityRESTMapper) ResourceFor Uses

func (m PriorityRESTMapper) ResourceFor(partiallySpecifiedResource schema.GroupVersionResource) (schema.GroupVersionResource, error)

ResourceFor finds all resources, then passes them through the ResourcePriority patterns to find a single matching hit.

func (PriorityRESTMapper) ResourceSingularizer Uses

func (m PriorityRESTMapper) ResourceSingularizer(resource string) (singular string, err error)

func (PriorityRESTMapper) ResourcesFor Uses

func (m PriorityRESTMapper) ResourcesFor(partiallySpecifiedResource schema.GroupVersionResource) ([]schema.GroupVersionResource, error)

func (PriorityRESTMapper) String Uses

func (m PriorityRESTMapper) String() string

type RESTMapper Uses

type RESTMapper interface {
    // KindFor takes a partial resource and returns the single match.  Returns an error if there are multiple matches
    KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error)

    // KindsFor takes a partial resource and returns the list of potential kinds in priority order
    KindsFor(resource schema.GroupVersionResource) ([]schema.GroupVersionKind, error)

    // ResourceFor takes a partial resource and returns the single match.  Returns an error if there are multiple matches
    ResourceFor(input schema.GroupVersionResource) (schema.GroupVersionResource, error)

    // ResourcesFor takes a partial resource and returns the list of potential resource in priority order
    ResourcesFor(input schema.GroupVersionResource) ([]schema.GroupVersionResource, error)

    // RESTMapping identifies a preferred resource mapping for the provided group kind.
    RESTMapping(gk schema.GroupKind, versions ...string) (*RESTMapping, error)
    // RESTMappings returns all resource mappings for the provided group kind if no
    // version search is provided. Otherwise identifies a preferred resource mapping for
    // the provided version(s).
    RESTMappings(gk schema.GroupKind, versions ...string) ([]*RESTMapping, error)

    ResourceSingularizer(resource string) (singular string, err error)
}

RESTMapper allows clients to map resources to kind, and map kind and version to interfaces for manipulating those objects. It is primarily intended for consumers of Kubernetes compatible REST APIs as defined in docs/devel/api-conventions.md.

The Kubernetes API provides versioned resources and object kinds which are scoped to API groups. In other words, kinds and resources should not be assumed to be unique across groups.

TODO: split into sub-interfaces

func NewLazyRESTMapperLoader Uses

func NewLazyRESTMapperLoader(fn func() (RESTMapper, error)) RESTMapper

NewLazyObjectLoader handles unrecoverable errors when creating a RESTMapper / ObjectTyper by returning those initialization errors when the interface methods are invoked. This defers the initialization and any server calls until a client actually needs to perform the action.

type RESTMapping Uses

type RESTMapping struct {
    // Resource is the GroupVersionResource (location) for this endpoint
    Resource schema.GroupVersionResource

    // GroupVersionKind is the GroupVersionKind (data format) to submit to this endpoint
    GroupVersionKind schema.GroupVersionKind

    // Scope contains the information needed to deal with REST Resources that are in a resource hierarchy
    Scope RESTScope
}

RESTMapping contains the information needed to deal with objects of a specific resource and kind in a RESTful manner.

type RESTScope Uses

type RESTScope interface {
    // Name of the scope
    Name() RESTScopeName
}

RESTScope contains the information needed to deal with REST resources that are in a resource hierarchy

type RESTScopeName Uses

type RESTScopeName string
const (
    RESTScopeNameNamespace RESTScopeName = "namespace"
    RESTScopeNameRoot      RESTScopeName = "root"
)

type Type Uses

type Type metav1.Type

Type exposes the type and APIVersion of versioned or internal API objects.

func TypeAccessor Uses

func TypeAccessor(obj interface{}) (Type, error)

TypeAccessor returns an interface that allows retrieving and modifying the APIVersion and Kind of an in-memory internal object. TODO: this interface is used to test code that does not have ObjectMeta or ListMeta in round tripping (objects which can use apiVersion/kind, but do not fit the Kube api conventions).

Directories

PathSynopsis
table
testrestmapper

Package meta imports 14 packages (graph) and is imported by 1351 packages. Updated 2019-05-12. Refresh now. Tools for package owners.