Documentation
¶
Index ¶
- func FieldIndexName(field string) string
- func KeyToNamespacedKey(ns string, baseKey string) string
- type Cache
- type CacheReader
- type GetOptions
- type Informers
- func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object, ...) (bool, *Cache, error)
- func (ip *Informers) Peek(gvk schema.GroupVersionKind, obj runtime.Object) (res *Cache, started bool, ok bool)
- func (ip *Informers) Remove(gvk schema.GroupVersionKind, obj runtime.Object)
- func (ip *Informers) Start(ctx context.Context) error
- func (ip *Informers) WaitForCacheSync(ctx context.Context) bool
- type InformersOpts
- type Selector
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FieldIndexName ¶
FieldIndexName constructs the name of the index over the given field, for use with an indexer.
func KeyToNamespacedKey ¶
KeyToNamespacedKey prefixes the given index key with a namespace for use in field selector indexes.
Types ¶
type Cache ¶ added in v0.15.0
type Cache struct {
// Informer is the cached informer
Informer cache.SharedIndexInformer
// CacheReader wraps Informer and implements the CacheReader interface for a single type
Reader CacheReader
// contains filtered or unexported fields
}
Cache contains the cached data for an Cache.
type CacheReader ¶
type CacheReader struct {
// contains filtered or unexported fields
}
CacheReader wraps a cache.Index to implement the client.Reader interface for a single type.
func (*CacheReader) Get ¶
func (c *CacheReader) Get(_ context.Context, key client.ObjectKey, out client.Object, _ ...client.GetOption) error
Get checks the indexer for the object and writes a copy of it if found.
func (*CacheReader) List ¶
func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...client.ListOption) error
List lists items out of the indexer and writes them to out.
type GetOptions ¶ added in v0.16.0
type GetOptions struct {
// BlockUntilSynced controls if the informer retrieval will block until the informer is synced. Defaults to `true`.
BlockUntilSynced *bool
}
GetOptions provides configuration to customize the behavior when getting an informer.
type Informers ¶ added in v0.15.0
type Informers struct {
// contains filtered or unexported fields
}
Informers create and caches Informers for (runtime.Object, schema.GroupVersionKind) pairs. It uses a standard parameter codec constructed based on the given generated Scheme.
func NewInformers ¶ added in v0.15.0
func NewInformers(config *rest.Config, options *InformersOpts) *Informers
NewInformers creates a new InformersMap that can create informers under the hood.
func (*Informers) Get ¶ added in v0.15.0
func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object, opts *GetOptions) (bool, *Cache, error)
Get will create a new Informer and add it to the map of specificInformersMap if none exists. Returns the Informer from the map.
func (*Informers) Peek ¶ added in v0.16.0
func (ip *Informers) Peek(gvk schema.GroupVersionKind, obj runtime.Object) (res *Cache, started bool, ok bool)
Peek attempts to get the informer for the GVK, but does not start one if one does not exist.
func (*Informers) Remove ¶ added in v0.17.0
func (ip *Informers) Remove(gvk schema.GroupVersionKind, obj runtime.Object)
Remove removes an informer entry and stops it if it was running.
type InformersOpts ¶ added in v0.15.0
type InformersOpts struct {
HTTPClient *http.Client
Scheme *runtime.Scheme
Mapper meta.RESTMapper
ResyncPeriod time.Duration
Namespace string
NewInformer *func(cache.ListerWatcher, runtime.Object, time.Duration, cache.Indexers) cache.SharedIndexInformer
Selector Selector
Transform cache.TransformFunc
UnsafeDisableDeepCopy bool
WatchErrorHandler cache.WatchErrorHandler
}
InformersOpts configures an InformerMap.
type Selector ¶ added in v0.9.0
Selector specify the label/field selector to fill in ListOptions.
func (Selector) ApplyToList ¶ added in v0.9.0
func (s Selector) ApplyToList(listOpts *metav1.ListOptions)
ApplyToList fill in ListOptions LabelSelector and FieldSelector if needed.