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
- Variables
- func Convert_api_ProjectList_To_v1_ProjectList(in *api.ProjectList, out *ProjectList, s conversion.Scope) error
- func Convert_api_ProjectRequest_To_v1_ProjectRequest(in *api.ProjectRequest, out *ProjectRequest, s conversion.Scope) error
- func Convert_api_ProjectSpec_To_v1_ProjectSpec(in *api.ProjectSpec, out *ProjectSpec, s conversion.Scope) error
- func Convert_api_ProjectStatus_To_v1_ProjectStatus(in *api.ProjectStatus, out *ProjectStatus, s conversion.Scope) error
- func Convert_api_Project_To_v1_Project(in *api.Project, out *Project, s conversion.Scope) error
- func Convert_v1_ProjectList_To_api_ProjectList(in *ProjectList, out *api.ProjectList, s conversion.Scope) error
- func Convert_v1_ProjectRequest_To_api_ProjectRequest(in *ProjectRequest, out *api.ProjectRequest, s conversion.Scope) error
- func Convert_v1_ProjectSpec_To_api_ProjectSpec(in *ProjectSpec, out *api.ProjectSpec, s conversion.Scope) error
- func Convert_v1_ProjectStatus_To_api_ProjectStatus(in *ProjectStatus, out *api.ProjectStatus, s conversion.Scope) error
- func Convert_v1_Project_To_api_Project(in *Project, out *api.Project, s conversion.Scope) error
- func DeepCopy_v1_Project(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_ProjectList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_ProjectRequest(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_ProjectSpec(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_ProjectStatus(in interface{}, out interface{}, c *conversion.Cloner) error
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- type Project
- func (*Project) Descriptor() ([]byte, []int)
- func (m *Project) Marshal() (data []byte, err error)
- func (m *Project) MarshalTo(data []byte) (int, error)
- func (*Project) ProtoMessage()
- func (m *Project) Reset()
- func (m *Project) Size() (n int)
- func (this *Project) String() string
- func (Project) SwaggerDoc() map[string]string
- func (m *Project) Unmarshal(data []byte) error
- type ProjectList
- func (*ProjectList) Descriptor() ([]byte, []int)
- func (m *ProjectList) Marshal() (data []byte, err error)
- func (m *ProjectList) MarshalTo(data []byte) (int, error)
- func (*ProjectList) ProtoMessage()
- func (m *ProjectList) Reset()
- func (m *ProjectList) Size() (n int)
- func (this *ProjectList) String() string
- func (ProjectList) SwaggerDoc() map[string]string
- func (m *ProjectList) Unmarshal(data []byte) error
- type ProjectRequest
- func (*ProjectRequest) Descriptor() ([]byte, []int)
- func (m *ProjectRequest) Marshal() (data []byte, err error)
- func (m *ProjectRequest) MarshalTo(data []byte) (int, error)
- func (*ProjectRequest) ProtoMessage()
- func (m *ProjectRequest) Reset()
- func (m *ProjectRequest) Size() (n int)
- func (this *ProjectRequest) String() string
- func (ProjectRequest) SwaggerDoc() map[string]string
- func (m *ProjectRequest) Unmarshal(data []byte) error
- type ProjectSpec
- func (*ProjectSpec) Descriptor() ([]byte, []int)
- func (m *ProjectSpec) Marshal() (data []byte, err error)
- func (m *ProjectSpec) MarshalTo(data []byte) (int, error)
- func (*ProjectSpec) ProtoMessage()
- func (m *ProjectSpec) Reset()
- func (m *ProjectSpec) Size() (n int)
- func (this *ProjectSpec) String() string
- func (ProjectSpec) SwaggerDoc() map[string]string
- func (m *ProjectSpec) Unmarshal(data []byte) error
- type ProjectStatus
- func (*ProjectStatus) Descriptor() ([]byte, []int)
- func (m *ProjectStatus) Marshal() (data []byte, err error)
- func (m *ProjectStatus) MarshalTo(data []byte) (int, error)
- func (*ProjectStatus) ProtoMessage()
- func (m *ProjectStatus) Reset()
- func (m *ProjectStatus) Size() (n int)
- func (this *ProjectStatus) String() string
- func (ProjectStatus) SwaggerDoc() map[string]string
- func (m *ProjectStatus) Unmarshal(data []byte) error
Constants ¶
const ( GroupName = "project.openshift.io" LegacyGroupName = "" )
const ( // These are internal finalizer values to Origin FinalizerOrigin kapi.FinalizerName = "openshift.io/origin" )
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
var ( SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"} LegacySchemeGroupVersion = unversioned.GroupVersion{Group: LegacyGroupName, Version: "v1"} LegacySchemeBuilder = runtime.NewSchemeBuilder(addLegacyKnownTypes, addConversionFuncs) AddToSchemeInCoreGroup = LegacySchemeBuilder.AddToScheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs) AddToScheme = SchemeBuilder.AddToScheme )
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_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 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
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies ¶ added in v1.4.0
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) ProtoMessage ¶ added in v1.3.0
func (*Project) ProtoMessage()
func (Project) SwaggerDoc ¶ added in v1.1.4
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) 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) 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