package
1.2.0-alpha.3
Repository: https://github.com/johscheuer/kubernetes.git
Documentation: pkg.go.dev

# Functions

IndexFuncToKeyFuncAdapter adapts an indexFunc to a keyFunc.
MetaNamespaceIndexFunc is a default index function that indexes based on an object's namespace.
MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API objects which implement meta.Interface.
NewDeltaFIFO returns a Store which can be used process changes to items.
No description provided by the author
NewFIFO returns a Store which can be used to queue up items to process.
NewIndexer returns an Indexer implemented simply with a map and a lock.
NewListWatchFromClient creates a new ListWatch from the specified client, resource, namespace and field selector.
NewNamedReflector same as NewReflector, but with a specified name for logging.
NewNamespaceKeyedIndexerAndReflector creates an Indexer and a Reflector The indexer is configured to key on namespace.
NewReflector creates a new Reflector object which will keep the given store up to date with the server's contents for the given resource.
NewStore returns a Store implemented simply with a map and a lock.
No description provided by the author
NewTTLStore creates and returns a ExpirationCache with a TTLPolicy.
NewUndeltaStore returns an UndeltaStore implemented with a Store.
SplitMetaNamespaceKey returns the namespace and name that MetaNamespaceKeyFunc encoded into key.

# Constants

No description provided by the author
No description provided by the author
The other types are obvious.
No description provided by the author

# Variables

ErrZeroLengthDeltasObject is returned in a KeyError if a Deltas object with zero length is encountered (should be impossible, even if such an object is accidentally produced by a DeltaCompressor-- but included for completeness).

# Structs

DeletedFinalStateUnknown is placed into a DeltaFIFO in the case where an object was deleted but the watch deletion event was missed.
Delta is the type stored by a DeltaFIFO.
DeltaFIFO is like FIFO, but allows you to process deletes.
ExpirationCache implements the store interface 1.
No description provided by the author
FIFO receives adds and updates from a Reflector, and puts them in a queue for FIFO order processing.
KeyError will be returned any time a KeyFunc gives an error; it includes the object at fault.
ListWatch knows how to list and watch a set of apiserver resources.
Reflector watches a specified resource and causes all changes to be reflected in the given store.
StoreToDaemonSetLister gives a store List and Exists methods.
StoreToEndpointsLister makes a Store that lists endpoints.
StoreToJobLister gives a store List and Exists methods.
StoreToNodeLister makes a Store have the List method of the client.NodeInterface The Store must contain (only) Nodes.
StoreToPodLister makes a Store have the List method of the client.PodInterface The Store must contain (only) Pods.
StoreToReplicationControllerLister gives a store List and Exists methods.
StoreToServiceLister makes a Store that has the List method of the client.ServiceInterface The Store must contain (only) Services.
TTLPolicy implements a ttl based ExpirationPolicy.
UndeltaStore listens to incremental updates and sends complete state on every change.

# Interfaces

DeltaCompressor is an algorithm that removes redundant changes.
ExpirationPolicy dictates when an object expires.
Getter interface knows how to access Get method from RESTClient.
Indexer is a storage interface that lets you list objects using multiple indexing functions.
A KeyGetter is anything that knows how to get the value stored under a given key.
A KeyLister is anything that knows how to list its keys.
A KeyListerGetter is anything that knows how to list its keys and look up by key.
ListerWatcher is any object that knows how to perform an initial list and start a watch on a resource.
Queue is exactly like a Store, but has a Pop() method too.
Store is a generic object storage interface.
ThreadSafeStore is an interface that allows concurrent access to a storage backend.

# Type aliases

DeltaCompressorFunc should remove redundant changes; but changes that are redundant depend on one's desired semantics, so this is an injectable function.
Deltas is a list of one or more 'Delta's to an individual object.
DeltaType is the type of a change (addition, deletion, etc).
ExplicitKey can be passed to MetaNamespaceKeyFunc if you have the key for the object but not the object itself.
Index maps the indexed value to a set of keys in the store that match on that value.
Indexers maps a name to a IndexFunc.
IndexFunc knows how to provide an indexed value for an object.
Indices maps a name to an Index.
KeyFunc knows how to make a key from an object.
ListFunc knows how to list resources.
NodeConditionPredicate is a function that indicates whether the given node's conditions meet some set of criteria defined by the function.
WatchFunc knows how to watch resources.