listers

Documentation

Overview

Package listers provides generated listers for Kubernetes APIs.

Index

• type ResourceIndexer
  • func New[T runtime.Object](indexer cache.Indexer, resource schema.GroupResource) ResourceIndexer[T]
  • func NewNamespaced[T runtime.Object](parent ResourceIndexer[T], namespace string) ResourceIndexer[T]
  • func (l ResourceIndexer[T]) Get(name string) (T, error)
  • func (l ResourceIndexer[T]) List(selector labels.Selector) (ret []T, err error)

Types

type ResourceIndexer

type ResourceIndexer[T runtime.Object] struct {
	// contains filtered or unexported fields
}

ResourceIndexer wraps an indexer, resource, and optional namespace for a given type. This is intended for use by listers (generated by lister-gen) only.

func New

func New[T runtime.Object](indexer cache.Indexer, resource schema.GroupResource) ResourceIndexer[T]

New returns a new instance of a lister (resource indexer) wrapping the given indexer and resource for the specified type. This is intended for use by listers (generated by lister-gen) only.

func NewNamespaced

func NewNamespaced[T runtime.Object](parent ResourceIndexer[T], namespace string) ResourceIndexer[T]

NewNamespaced returns a new instance of a namespaced lister (resource indexer) wrapping the given parent and namespace for the specified type. This is intended for use by listers (generated by lister-gen) only.

func (ResourceIndexer[T]) Get

func (l ResourceIndexer[T]) Get(name string) (T, error)

Get retrieves the resource from the index for a given name.

func (ResourceIndexer[T]) List

func (l ResourceIndexer[T]) List(selector labels.Selector) (ret []T, err error)

List lists all resources in the indexer matching the given selector.