api

package
v1.5.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package api is the internal version of the API.

Index

Constants

View Source
const (
	// ProjectDisplayName is an annotation that stores the name displayed when querying for projects
	ProjectDisplayName = "openshift.io/display-name"
	// ProjectDescription is an annotatoion that holds the description of the project
	ProjectDescription = "openshift.io/description"
	// ProjectNodeSelector is an annotation that holds the node selector;
	// the node selector annotation determines which nodes will have pods from this project scheduled to them
	ProjectNodeSelector = "openshift.io/node-selector"
	// ProjectRequester is the username that requested a given project.  Its not guaranteed to be present,
	// but it is set by the default project template.
	ProjectRequester = "openshift.io/requester"
)

These constants represent annotations keys affixed to projects

View Source
const (
	// These are internal finalizer values to Origin
	FinalizerOrigin kapi.FinalizerName = "openshift.io/origin"
)
View Source
const FutureGroupName = "project.openshift.io"
View Source
const GroupName = ""

Variables

View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_api_Project added in v1.3.0

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

func DeepCopy_api_ProjectList added in v1.3.0

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

func DeepCopy_api_ProjectRequest added in v1.3.0

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

func DeepCopy_api_ProjectSpec added in v1.3.0

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

func DeepCopy_api_ProjectStatus added in v1.3.0

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

func DisplayNameAndNameForProject

func DisplayNameAndNameForProject(project *Project) string

DisplayNameAndNameForProject returns a formatted string containing the name of the project and includes the display name if it differs.

func Kind added in v1.1.2

func Kind(kind string) unversioned.GroupKind

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

func RegisterDeepCopies added in v1.4.0

func RegisterDeepCopies(scheme *runtime.Scheme) error

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

func Resource added in v1.1.2

func Resource(resource string) unversioned.GroupResource

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

Types

type Project

type Project struct {
	unversioned.TypeMeta
	kapi.ObjectMeta

	Spec   ProjectSpec
	Status ProjectStatus
}

Project is a logical top-level container for a set of origin resources

func (*Project) GetObjectKind added in v1.1.3

func (obj *Project) GetObjectKind() unversioned.ObjectKind

type ProjectList

type ProjectList struct {
	unversioned.TypeMeta
	unversioned.ListMeta
	Items []Project
}

ProjectList is a list of Project objects.

func (*ProjectList) GetObjectKind added in v1.1.3

func (obj *ProjectList) GetObjectKind() unversioned.ObjectKind

type ProjectRequest

type ProjectRequest struct {
	unversioned.TypeMeta
	kapi.ObjectMeta
	DisplayName string
	Description string
}

func (*ProjectRequest) GetObjectKind added in v1.1.3

func (obj *ProjectRequest) GetObjectKind() unversioned.ObjectKind

type ProjectSpec

type ProjectSpec struct {
	// Finalizers is an opaque list of values that must be empty to permanently remove object from storage
	Finalizers []kapi.FinalizerName
}

ProjectSpec describes the attributes on a Project

type ProjectStatus

type ProjectStatus struct {
	Phase kapi.NamespacePhase
}

ProjectStatus is information about the current status of a Project

Directories

Path Synopsis
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL