user

Documentation

Index

• Variables
• func GetAttrs(o runtime.Object) (labels.Set, fields.Set, error)
• func Matcher(label labels.Selector, field fields.Selector) kstorage.SelectionPredicate
• func SelectableFields(obj *userapi.User) fields.Set
• type Registry
  • func NewRegistry(s Storage) Registry
• type Storage

Variables

var Strategy = userStrategy{kapi.Scheme}

Strategy is the default logic that applies when creating and updating User objects via the REST API.

Functions

func GetAttrs

func GetAttrs(o runtime.Object) (labels.Set, fields.Set, error)

GetAttrs returns labels and fields of a given object for filtering purposes

func Matcher

func Matcher(label labels.Selector, field fields.Selector) kstorage.SelectionPredicate

Matcher returns a generic matcher for a given label and field selector.

func SelectableFields

func SelectableFields(obj *userapi.User) fields.Set

SelectableFields returns a field set that can be used for filter selection

Types

type Registry

type Registry interface {
	// ListUsers obtains a list of users having labels which match selector.
	ListUsers(ctx apirequest.Context, options *metainternal.ListOptions) (*userapi.UserList, error)
	// GetUser returns a specific user
	GetUser(ctx apirequest.Context, name string, options *metav1.GetOptions) (*userapi.User, error)
	// CreateUser creates a user
	CreateUser(ctx apirequest.Context, user *userapi.User) (*userapi.User, error)
	// UpdateUser updates an existing user
	UpdateUser(ctx apirequest.Context, user *userapi.User) (*userapi.User, error)
}

Registry is an interface implemented by things that know how to store User objects.

func NewRegistry

func NewRegistry(s Storage) Registry

NewRegistry returns a new Registry interface for the given Storage. Any mismatched types will panic.

type Storage

type Storage interface {
	rest.Lister
	rest.Getter

	Create(ctx apirequest.Context, obj runtime.Object) (runtime.Object, error)
	Update(ctx apirequest.Context, name string, objInfo rest.UpdatedObjectInfo) (runtime.Object, bool, error)
}

Storage is an interface for a standard REST Storage backend TODO: move me somewhere common