Help us shape the future of Go! Take the 2026 Go Developer Survey

v1

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2017 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API.

Package v1 is a generated protocol buffer package.

It is generated from these files:
	github.com/openshift/origin/pkg/project/api/v1/generated.proto

It has these top-level messages:
	Project
	ProjectList
	ProjectRequest
	ProjectSpec
	ProjectStatus

Index

Constants

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

Variables

View Source
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_api_ProjectList_To_v1_ProjectList added in v1.3.0

func Convert_api_ProjectList_To_v1_ProjectList(in *api.ProjectList, out *ProjectList, s conversion.Scope) error

func Convert_api_ProjectRequest_To_v1_ProjectRequest added in v1.3.0

func Convert_api_ProjectRequest_To_v1_ProjectRequest(in *api.ProjectRequest, out *ProjectRequest, s conversion.Scope) error

func Convert_api_ProjectSpec_To_v1_ProjectSpec added in v1.3.0

func Convert_api_ProjectSpec_To_v1_ProjectSpec(in *api.ProjectSpec, out *ProjectSpec, s conversion.Scope) error

func Convert_api_ProjectStatus_To_v1_ProjectStatus added in v1.3.0

func Convert_api_ProjectStatus_To_v1_ProjectStatus(in *api.ProjectStatus, out *ProjectStatus, s conversion.Scope) error

func Convert_api_Project_To_v1_Project added in v1.3.0

func Convert_api_Project_To_v1_Project(in *api.Project, out *Project, s conversion.Scope) error

func Convert_v1_ProjectList_To_api_ProjectList added in v1.3.0

func Convert_v1_ProjectList_To_api_ProjectList(in *ProjectList, out *api.ProjectList, s conversion.Scope) error

func Convert_v1_ProjectRequest_To_api_ProjectRequest added in v1.3.0

func Convert_v1_ProjectRequest_To_api_ProjectRequest(in *ProjectRequest, out *api.ProjectRequest, s conversion.Scope) error

func Convert_v1_ProjectSpec_To_api_ProjectSpec added in v1.3.0

func Convert_v1_ProjectSpec_To_api_ProjectSpec(in *ProjectSpec, out *api.ProjectSpec, s conversion.Scope) error

func Convert_v1_ProjectStatus_To_api_ProjectStatus added in v1.3.0

func Convert_v1_ProjectStatus_To_api_ProjectStatus(in *ProjectStatus, out *api.ProjectStatus, s conversion.Scope) error

func Convert_v1_Project_To_api_Project added in v1.3.0

func Convert_v1_Project_To_api_Project(in *Project, out *api.Project, s conversion.Scope) error

func DeepCopy_v1_Project added in v1.3.0

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

func DeepCopy_v1_ProjectList added in v1.3.0

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

func DeepCopy_v1_ProjectRequest added in v1.3.0

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

func DeepCopy_v1_ProjectSpec added in v1.3.0

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

func DeepCopy_v1_ProjectStatus added in v1.3.0

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

func RegisterConversions added in v1.4.0

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

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.

Types

type Project

type Project struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec defines the behavior of the Namespace.
	Spec ProjectSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Status describes the current status of a Namespace
	Status ProjectStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members, a quota on the resources that the project may consume, and the security controls on the resources in the project. Within a project, members may have different roles - project administrators can set membership, editors can create and manage the resources, and viewers can see but not access running containers. In a normal cluster project administrators are not able to alter their quotas - that is restricted to cluster administrators.

Listing or watching projects will return only projects the user has the reader role on.

An OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.

func (*Project) Descriptor added in v1.4.0

func (*Project) Descriptor() ([]byte, []int)

func (*Project) GetObjectKind added in v1.1.3

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

func (*Project) Marshal added in v1.3.0

func (m *Project) Marshal() (data []byte, err error)

func (*Project) MarshalTo added in v1.3.0

func (m *Project) MarshalTo(data []byte) (int, error)

func (*Project) ProtoMessage added in v1.3.0

func (*Project) ProtoMessage()

func (*Project) Reset added in v1.3.0

func (m *Project) Reset()

func (*Project) Size added in v1.3.0

func (m *Project) Size() (n int)

func (*Project) String added in v1.3.0

func (this *Project) String() string

func (Project) SwaggerDoc added in v1.1.4

func (Project) SwaggerDoc() map[string]string

func (*Project) Unmarshal added in v1.3.0

func (m *Project) Unmarshal(data []byte) error

type ProjectList

type ProjectList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	// Items is the list of projects
	Items []Project `json:"items" protobuf:"bytes,2,rep,name=items"`
}

ProjectList is a list of Project objects.

func (*ProjectList) Descriptor added in v1.4.0

func (*ProjectList) Descriptor() ([]byte, []int)

func (*ProjectList) GetObjectKind added in v1.1.3

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

func (*ProjectList) Marshal added in v1.3.0

func (m *ProjectList) Marshal() (data []byte, err error)

func (*ProjectList) MarshalTo added in v1.3.0

func (m *ProjectList) MarshalTo(data []byte) (int, error)

func (*ProjectList) ProtoMessage added in v1.3.0

func (*ProjectList) ProtoMessage()

func (*ProjectList) Reset added in v1.3.0

func (m *ProjectList) Reset()

func (*ProjectList) Size added in v1.3.0

func (m *ProjectList) Size() (n int)

func (*ProjectList) String added in v1.3.0

func (this *ProjectList) String() string

func (ProjectList) SwaggerDoc added in v1.1.4

func (ProjectList) SwaggerDoc() map[string]string

func (*ProjectList) Unmarshal added in v1.3.0

func (m *ProjectList) Unmarshal(data []byte) error

type ProjectRequest

type ProjectRequest struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
	// DisplayName is the display name to apply to a project
	DisplayName string `json:"displayName,omitempty" protobuf:"bytes,2,opt,name=displayName"`
	// Description is the description to apply to a project
	Description string `json:"description,omitempty" protobuf:"bytes,3,opt,name=description"`
}

ProjecRequest is the set of options necessary to fully qualify a project request

func (*ProjectRequest) Descriptor added in v1.4.0

func (*ProjectRequest) Descriptor() ([]byte, []int)

func (*ProjectRequest) GetObjectKind added in v1.1.3

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

func (*ProjectRequest) Marshal added in v1.3.0

func (m *ProjectRequest) Marshal() (data []byte, err error)

func (*ProjectRequest) MarshalTo added in v1.3.0

func (m *ProjectRequest) MarshalTo(data []byte) (int, error)

func (*ProjectRequest) ProtoMessage added in v1.3.0

func (*ProjectRequest) ProtoMessage()

func (*ProjectRequest) Reset added in v1.3.0

func (m *ProjectRequest) Reset()

func (*ProjectRequest) Size added in v1.3.0

func (m *ProjectRequest) Size() (n int)

func (*ProjectRequest) String added in v1.3.0

func (this *ProjectRequest) String() string

func (ProjectRequest) SwaggerDoc added in v1.1.4

func (ProjectRequest) SwaggerDoc() map[string]string

func (*ProjectRequest) Unmarshal added in v1.3.0

func (m *ProjectRequest) Unmarshal(data []byte) error

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 `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=k8s.io/kubernetes/pkg/api/v1.FinalizerName"`
}

ProjectSpec describes the attributes on a Project

func (*ProjectSpec) Descriptor added in v1.4.0

func (*ProjectSpec) Descriptor() ([]byte, []int)

func (*ProjectSpec) Marshal added in v1.3.0

func (m *ProjectSpec) Marshal() (data []byte, err error)

func (*ProjectSpec) MarshalTo added in v1.3.0

func (m *ProjectSpec) MarshalTo(data []byte) (int, error)

func (*ProjectSpec) ProtoMessage added in v1.3.0

func (*ProjectSpec) ProtoMessage()

func (*ProjectSpec) Reset added in v1.3.0

func (m *ProjectSpec) Reset()

func (*ProjectSpec) Size added in v1.3.0

func (m *ProjectSpec) Size() (n int)

func (*ProjectSpec) String added in v1.3.0

func (this *ProjectSpec) String() string

func (ProjectSpec) SwaggerDoc added in v1.1.4

func (ProjectSpec) SwaggerDoc() map[string]string

func (*ProjectSpec) Unmarshal added in v1.3.0

func (m *ProjectSpec) Unmarshal(data []byte) error

type ProjectStatus

type ProjectStatus struct {
	// Phase is the current lifecycle phase of the project
	Phase kapi.NamespacePhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=k8s.io/kubernetes/pkg/api/v1.NamespacePhase"`
}

ProjectStatus is information about the current status of a Project

func (*ProjectStatus) Descriptor added in v1.4.0

func (*ProjectStatus) Descriptor() ([]byte, []int)

func (*ProjectStatus) Marshal added in v1.3.0

func (m *ProjectStatus) Marshal() (data []byte, err error)

func (*ProjectStatus) MarshalTo added in v1.3.0

func (m *ProjectStatus) MarshalTo(data []byte) (int, error)

func (*ProjectStatus) ProtoMessage added in v1.3.0

func (*ProjectStatus) ProtoMessage()

func (*ProjectStatus) Reset added in v1.3.0

func (m *ProjectStatus) Reset()

func (*ProjectStatus) Size added in v1.3.0

func (m *ProjectStatus) Size() (n int)

func (*ProjectStatus) String added in v1.3.0

func (this *ProjectStatus) String() string

func (ProjectStatus) SwaggerDoc added in v1.1.4

func (ProjectStatus) SwaggerDoc() map[string]string

func (*ProjectStatus) Unmarshal added in v1.3.0

func (m *ProjectStatus) Unmarshal(data []byte) error

Jump to

Keyboard shortcuts

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