Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsAmbiguousError ¶
func IsNonexistentError ¶
Types ¶
type AmbiguousError ¶
type AmbiguousError struct {
// contains filtered or unexported fields
}
func NewAmbiguousError ¶
func NewAmbiguousError(format string, data ...interface{}) *AmbiguousError
type BaseFilter ¶
type BaseFilter interface {
// AmbiguousError specifies what to error if
// a single request returned multiple matches
// The matches are given as an argument
AmbiguousError([]Match) *AmbiguousError
// NonexistentError specifies what to error if
// a single request returned no matches
NonexistentError() *NonexistentError
// SetKind sets the kind for the filter
SetKind(runtime.Kind)
}
BaseFilter provides shared functionality for filter types
type Filterer ¶
type Filterer struct {
// contains filtered or unexported fields
}
func NewFilterer ¶
func (*Filterer) Find ¶
func (f *Filterer) Find(gvk schema.GroupVersionKind, filter BaseFilter) (runtime.Object, error)
Find a single runtime.Object of the given kind using the given filter
func (*Filterer) FindAll ¶
func (f *Filterer) FindAll(gvk schema.GroupVersionKind, filter BaseFilter) ([]runtime.Object, error)
Find all runtime.Objects of the given kind using the given filter
type GenericMatch ¶
type GenericMatch struct {
// contains filtered or unexported fields
}
GenericMatch is the simplest implementation of Match, carrying no additional data
func (*GenericMatch) Exact ¶
func (m *GenericMatch) Exact() bool
func (*GenericMatch) Object ¶
func (m *GenericMatch) Object() runtime.Object
type Match ¶
type Match interface {
// Get the matched Object
Object() runtime.Object
// Check if the match was exact
Exact() bool
}
Match describes the result of filtering an Object If the Object to be filtered didn't match, return nil
type MetaFilter ¶
type MetaFilter interface {
BaseFilter
// Every Object to be filtered is passed though FilterMeta, which should
// return the Object on match, or nil if it doesn't match. The Objects
// given to FilterMeta are of type runtime.APIType, stripped of other contents.
// The boolean indicates an exact match.
FilterMeta(runtime.Object) (Match, error)
}
MetaFilter implementations operate on runtime.APIType objects, which are more light weight, but provide only name/UID matching.
type NonexistentError ¶
type NonexistentError struct {
// contains filtered or unexported fields
}
func NewNonexistentError ¶
func NewNonexistentError(format string, data ...interface{}) *NonexistentError
type ObjectFilter ¶
type ObjectFilter interface {
BaseFilter
// Every Object to be filtered is passed though Filter, which should
// return the Object on match, or nil if it doesn't match.
// The boolean indicates an exact match.
Filter(runtime.Object) (Match, error)
}
ObjectFilter implementations filter fully loaded runtime.Objects
Click to show internal directories.
Click to hide internal directories.