Documentation ¶
Overview ¶
+groupName=project.openshift.io 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/api/project/v1/generated.proto It has these top-level messages: Project ProjectList ProjectRequest ProjectSpec ProjectStatus
Index ¶
- Constants
- Variables
- func RegisterDeepCopies(scheme *runtime.Scheme) errordeprecated
- func Resource(resource string) schema.GroupResource
- type Project
- func (in *Project) DeepCopy() *Project
- func (in *Project) DeepCopyInto(out *Project)
- func (in *Project) DeepCopyObject() runtime.Object
- 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 (in *ProjectList) DeepCopy() *ProjectList
- func (in *ProjectList) DeepCopyInto(out *ProjectList)
- func (in *ProjectList) DeepCopyObject() runtime.Object
- 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 (in *ProjectRequest) DeepCopy() *ProjectRequest
- func (in *ProjectRequest) DeepCopyInto(out *ProjectRequest)
- func (in *ProjectRequest) DeepCopyObject() runtime.Object
- 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 (in *ProjectSpec) DeepCopy() *ProjectSpec
- func (in *ProjectSpec) DeepCopyInto(out *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 (in *ProjectStatus) DeepCopy() *ProjectStatus
- func (in *ProjectStatus) DeepCopyInto(out *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 corev1.FinalizerName = "openshift.io/origin" )
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
var ( SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} LegacySchemeGroupVersion = schema.GroupVersion{Group: LegacyGroupName, Version: "v1"} 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 RegisterDeepCopies
deprecated
func Resource ¶
func Resource(resource string) schema.GroupResource
Types ¶
type Project ¶
type Project struct { metav1.TypeMeta `json:",inline"` // Standard object's metadata. metav1.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) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Project.
func (*Project) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Project) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Project) Descriptor ¶
func (*Project) ProtoMessage ¶
func (*Project) ProtoMessage()
func (Project) SwaggerDoc ¶
type ProjectList ¶
type ProjectList struct { metav1.TypeMeta `json:",inline"` // Standard object's metadata. metav1.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) DeepCopy ¶
func (in *ProjectList) DeepCopy() *ProjectList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectList.
func (*ProjectList) DeepCopyInto ¶
func (in *ProjectList) DeepCopyInto(out *ProjectList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProjectList) DeepCopyObject ¶
func (in *ProjectList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProjectList) Descriptor ¶
func (*ProjectList) Descriptor() ([]byte, []int)
func (*ProjectList) Marshal ¶
func (m *ProjectList) Marshal() (dAtA []byte, err error)
func (*ProjectList) ProtoMessage ¶
func (*ProjectList) ProtoMessage()
func (*ProjectList) Reset ¶
func (m *ProjectList) Reset()
func (*ProjectList) Size ¶
func (m *ProjectList) Size() (n int)
func (*ProjectList) String ¶
func (this *ProjectList) String() string
func (ProjectList) SwaggerDoc ¶
func (ProjectList) SwaggerDoc() map[string]string
func (*ProjectList) Unmarshal ¶
func (m *ProjectList) Unmarshal(dAtA []byte) error
type ProjectRequest ¶
type ProjectRequest struct { metav1.TypeMeta `json:",inline"` // Standard object's metadata. metav1.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) DeepCopy ¶
func (in *ProjectRequest) DeepCopy() *ProjectRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectRequest.
func (*ProjectRequest) DeepCopyInto ¶
func (in *ProjectRequest) DeepCopyInto(out *ProjectRequest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProjectRequest) DeepCopyObject ¶
func (in *ProjectRequest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ProjectRequest) Descriptor ¶
func (*ProjectRequest) Descriptor() ([]byte, []int)
func (*ProjectRequest) Marshal ¶
func (m *ProjectRequest) Marshal() (dAtA []byte, err error)
func (*ProjectRequest) ProtoMessage ¶
func (*ProjectRequest) ProtoMessage()
func (*ProjectRequest) Reset ¶
func (m *ProjectRequest) Reset()
func (*ProjectRequest) Size ¶
func (m *ProjectRequest) Size() (n int)
func (*ProjectRequest) String ¶
func (this *ProjectRequest) String() string
func (ProjectRequest) SwaggerDoc ¶
func (ProjectRequest) SwaggerDoc() map[string]string
func (*ProjectRequest) Unmarshal ¶
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 []corev1.FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=k8s.io/api/core/v1.FinalizerName"` }
ProjectSpec describes the attributes on a Project
func (*ProjectSpec) DeepCopy ¶
func (in *ProjectSpec) DeepCopy() *ProjectSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectSpec.
func (*ProjectSpec) DeepCopyInto ¶
func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProjectSpec) Descriptor ¶
func (*ProjectSpec) Descriptor() ([]byte, []int)
func (*ProjectSpec) Marshal ¶
func (m *ProjectSpec) Marshal() (dAtA []byte, err error)
func (*ProjectSpec) ProtoMessage ¶
func (*ProjectSpec) ProtoMessage()
func (*ProjectSpec) Reset ¶
func (m *ProjectSpec) Reset()
func (*ProjectSpec) Size ¶
func (m *ProjectSpec) Size() (n int)
func (*ProjectSpec) String ¶
func (this *ProjectSpec) String() string
func (ProjectSpec) SwaggerDoc ¶
func (ProjectSpec) SwaggerDoc() map[string]string
func (*ProjectSpec) Unmarshal ¶
func (m *ProjectSpec) Unmarshal(dAtA []byte) error
type ProjectStatus ¶
type ProjectStatus struct { // Phase is the current lifecycle phase of the project Phase corev1.NamespacePhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=k8s.io/api/core/v1.NamespacePhase"` }
ProjectStatus is information about the current status of a Project
func (*ProjectStatus) DeepCopy ¶
func (in *ProjectStatus) DeepCopy() *ProjectStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectStatus.
func (*ProjectStatus) DeepCopyInto ¶
func (in *ProjectStatus) DeepCopyInto(out *ProjectStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProjectStatus) Descriptor ¶
func (*ProjectStatus) Descriptor() ([]byte, []int)
func (*ProjectStatus) Marshal ¶
func (m *ProjectStatus) Marshal() (dAtA []byte, err error)
func (*ProjectStatus) ProtoMessage ¶
func (*ProjectStatus) ProtoMessage()
func (*ProjectStatus) Reset ¶
func (m *ProjectStatus) Reset()
func (*ProjectStatus) Size ¶
func (m *ProjectStatus) Size() (n int)
func (*ProjectStatus) String ¶
func (this *ProjectStatus) String() string
func (ProjectStatus) SwaggerDoc ¶
func (ProjectStatus) SwaggerDoc() map[string]string
func (*ProjectStatus) Unmarshal ¶
func (m *ProjectStatus) Unmarshal(dAtA []byte) error