api

Documentation

Overview

+groupName=user.openshift.io Package api is the internal version of the API.

Index

• Constants
• Variables
• func DeepCopy_api_Group(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_GroupList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_Identity(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_IdentityList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_User(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_UserIdentityMapping(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_UserList(in interface{}, out interface{}, c *conversion.Cloner) error
• func GroupToSelectableFields(group *Group) fields.Set
• func IdentityToSelectableFields(identity *Identity) fields.Set
• func IsKindOrLegacy(kind string, gk schema.GroupKind) bool
• func IsResourceOrLegacy(resource string, gr schema.GroupResource) bool
• func Kind(kind string) schema.GroupKind
• func LegacyKind(kind string) schema.GroupKind
• func LegacyResource(resource string) schema.GroupResource
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• func UserToSelectableFields(user *User) fields.Set
• type Group
• type GroupList
• type Identity
• type IdentityList
• type User
• type UserIdentityMapping
• type UserList

Constants

const (
	GroupName       = "user.openshift.io"
	LegacyGroupName = ""
)

Variables

var (
	SchemeGroupVersion       = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
	LegacySchemeGroupVersion = schema.GroupVersion{Group: LegacyGroupName, Version: runtime.APIVersionInternal}

	LegacySchemeBuilder    = runtime.NewSchemeBuilder(addLegacyKnownTypes)
	AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme

	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_api_Group

func DeepCopy_api_Group(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_GroupList

func DeepCopy_api_GroupList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_Identity

func DeepCopy_api_Identity(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_IdentityList

func DeepCopy_api_IdentityList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_User

func DeepCopy_api_User(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_UserIdentityMapping

func DeepCopy_api_UserIdentityMapping(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_UserList

func DeepCopy_api_UserList(in interface{}, out interface{}, c *conversion.Cloner) error

func GroupToSelectableFields

func GroupToSelectableFields(group *Group) fields.Set

GroupToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func IdentityToSelectableFields

func IdentityToSelectableFields(identity *Identity) fields.Set

IdentityToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

func IsKindOrLegacy

func IsKindOrLegacy(kind string, gk schema.GroupKind) bool

IsKindOrLegacy checks if the provided GroupKind matches with the given kind by looking up the API group and also the legacy API.

func IsResourceOrLegacy

func IsResourceOrLegacy(resource string, gr schema.GroupResource) bool

IsResourceOrLegacy checks if the provided GroupResources matches with the given resource by looking up the API group and also the legacy API.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func LegacyKind

func LegacyKind(kind string) schema.GroupKind

func LegacyResource

func LegacyResource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

func UserToSelectableFields

func UserToSelectableFields(user *User) fields.Set

UserToSelectableFields returns a label set that represents the object changes to the returned keys require registering conversions for existing versions using Scheme.AddFieldLabelConversionFunc

Types

type Group

type Group struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Users []string
}

Group represents a referenceable set of Users

type GroupList

type GroupList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []Group
}

type Identity

type Identity struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// ProviderName is the source of identity information
	ProviderName string

	// ProviderUserName uniquely represents this identity in the scope of the provider
	ProviderUserName string

	// User is a reference to the user this identity is associated with
	// Both Name and UID must be set
	User kapi.ObjectReference

	Extra map[string]string
}

type IdentityList

type IdentityList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []Identity
}

type User

type User struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	FullName string

	Identities []string

	Groups []string
}

type UserIdentityMapping

type UserIdentityMapping struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Identity kapi.ObjectReference
	User     kapi.ObjectReference
}

type UserList

type UserList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []User
}