Documentation

Overview

    +groupName=quota.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/quota/v1/generated.proto
    
    It has these top-level messages:
    	AppliedClusterResourceQuota
    	AppliedClusterResourceQuotaList
    	ClusterResourceQuota
    	ClusterResourceQuotaList
    	ClusterResourceQuotaSelector
    	ClusterResourceQuotaSpec
    	ClusterResourceQuotaStatus
    	ResourceQuotaStatusByNamespace
    

    Index

    Constants

    View Source
    const (
    	GroupName       = "quota.openshift.io"
    	LegacyGroupName = ""
    )

    Variables

    View Source
    var (
    	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
    )
    View Source
    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 Kind

      func Kind(kind string) schema.GroupKind

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

        func Resource

        func Resource(resource string) schema.GroupResource

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

          Types

          type AppliedClusterResourceQuota

          type AppliedClusterResourceQuota struct {
          	metav1.TypeMeta `json:",inline"`
          	// Standard object's metadata.
          	metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"`
          
          	// Spec defines the desired quota
          	Spec ClusterResourceQuotaSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
          
          	// Status defines the actual enforced quota and its current usage
          	Status ClusterResourceQuotaStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
          }

            AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.

            func (*AppliedClusterResourceQuota) DeepCopy

              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppliedClusterResourceQuota.

              func (*AppliedClusterResourceQuota) DeepCopyInto

                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                func (*AppliedClusterResourceQuota) DeepCopyObject

                func (in *AppliedClusterResourceQuota) DeepCopyObject() runtime.Object

                  DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                  func (*AppliedClusterResourceQuota) Descriptor

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

                  func (*AppliedClusterResourceQuota) Marshal

                  func (m *AppliedClusterResourceQuota) Marshal() (dAtA []byte, err error)

                  func (*AppliedClusterResourceQuota) MarshalTo

                  func (m *AppliedClusterResourceQuota) MarshalTo(dAtA []byte) (int, error)

                  func (*AppliedClusterResourceQuota) ProtoMessage

                  func (*AppliedClusterResourceQuota) ProtoMessage()

                  func (*AppliedClusterResourceQuota) Reset

                  func (m *AppliedClusterResourceQuota) Reset()

                  func (*AppliedClusterResourceQuota) Size

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

                  func (*AppliedClusterResourceQuota) String

                  func (this *AppliedClusterResourceQuota) String() string

                  func (AppliedClusterResourceQuota) SwaggerDoc

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

                  func (*AppliedClusterResourceQuota) Unmarshal

                  func (m *AppliedClusterResourceQuota) Unmarshal(dAtA []byte) error

                  type AppliedClusterResourceQuotaList

                  type AppliedClusterResourceQuotaList struct {
                  	metav1.TypeMeta `json:",inline"`
                  	// Standard object's metadata.
                  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                  
                  	// Items is a list of AppliedClusterResourceQuota
                  	Items []AppliedClusterResourceQuota `json:"items" protobuf:"bytes,2,rep,name=items"`
                  }

                    AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas

                    func (*AppliedClusterResourceQuotaList) DeepCopy

                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppliedClusterResourceQuotaList.

                      func (*AppliedClusterResourceQuotaList) DeepCopyInto

                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                        func (*AppliedClusterResourceQuotaList) DeepCopyObject

                        func (in *AppliedClusterResourceQuotaList) DeepCopyObject() runtime.Object

                          DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                          func (*AppliedClusterResourceQuotaList) Descriptor

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

                          func (*AppliedClusterResourceQuotaList) Marshal

                          func (m *AppliedClusterResourceQuotaList) Marshal() (dAtA []byte, err error)

                          func (*AppliedClusterResourceQuotaList) MarshalTo

                          func (m *AppliedClusterResourceQuotaList) MarshalTo(dAtA []byte) (int, error)

                          func (*AppliedClusterResourceQuotaList) ProtoMessage

                          func (*AppliedClusterResourceQuotaList) ProtoMessage()

                          func (*AppliedClusterResourceQuotaList) Reset

                          func (*AppliedClusterResourceQuotaList) Size

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

                          func (*AppliedClusterResourceQuotaList) String

                          func (this *AppliedClusterResourceQuotaList) String() string

                          func (AppliedClusterResourceQuotaList) SwaggerDoc

                          func (*AppliedClusterResourceQuotaList) Unmarshal

                          func (m *AppliedClusterResourceQuotaList) Unmarshal(dAtA []byte) error

                          type ClusterResourceQuota

                          type ClusterResourceQuota struct {
                          	metav1.TypeMeta `json:",inline"`
                          	// Standard object's metadata.
                          	metav1.ObjectMeta `json:"metadata" protobuf:"bytes,1,opt,name=metadata"`
                          
                          	// Spec defines the desired quota
                          	Spec ClusterResourceQuotaSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
                          
                          	// Status defines the actual enforced quota and its current usage
                          	Status ClusterResourceQuotaStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
                          }

                            ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.

                            func (*ClusterResourceQuota) DeepCopy

                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterResourceQuota.

                              func (*ClusterResourceQuota) DeepCopyInto

                              func (in *ClusterResourceQuota) DeepCopyInto(out *ClusterResourceQuota)

                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                func (*ClusterResourceQuota) DeepCopyObject

                                func (in *ClusterResourceQuota) DeepCopyObject() runtime.Object

                                  DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                  func (*ClusterResourceQuota) Descriptor

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

                                  func (*ClusterResourceQuota) Marshal

                                  func (m *ClusterResourceQuota) Marshal() (dAtA []byte, err error)

                                  func (*ClusterResourceQuota) MarshalTo

                                  func (m *ClusterResourceQuota) MarshalTo(dAtA []byte) (int, error)

                                  func (*ClusterResourceQuota) ProtoMessage

                                  func (*ClusterResourceQuota) ProtoMessage()

                                  func (*ClusterResourceQuota) Reset

                                  func (m *ClusterResourceQuota) Reset()

                                  func (*ClusterResourceQuota) Size

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

                                  func (*ClusterResourceQuota) String

                                  func (this *ClusterResourceQuota) String() string

                                  func (ClusterResourceQuota) SwaggerDoc

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

                                  func (*ClusterResourceQuota) Unmarshal

                                  func (m *ClusterResourceQuota) Unmarshal(dAtA []byte) error

                                  type ClusterResourceQuotaList

                                  type ClusterResourceQuotaList struct {
                                  	metav1.TypeMeta `json:",inline"`
                                  	// Standard object's metadata.
                                  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                                  
                                  	// Items is a list of ClusterResourceQuotas
                                  	Items []ClusterResourceQuota `json:"items" protobuf:"bytes,2,rep,name=items"`
                                  }

                                    ClusterResourceQuotaList is a collection of ClusterResourceQuotas

                                    func (*ClusterResourceQuotaList) DeepCopy

                                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterResourceQuotaList.

                                      func (*ClusterResourceQuotaList) DeepCopyInto

                                      func (in *ClusterResourceQuotaList) DeepCopyInto(out *ClusterResourceQuotaList)

                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                        func (*ClusterResourceQuotaList) DeepCopyObject

                                        func (in *ClusterResourceQuotaList) DeepCopyObject() runtime.Object

                                          DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                          func (*ClusterResourceQuotaList) Descriptor

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

                                          func (*ClusterResourceQuotaList) Marshal

                                          func (m *ClusterResourceQuotaList) Marshal() (dAtA []byte, err error)

                                          func (*ClusterResourceQuotaList) MarshalTo

                                          func (m *ClusterResourceQuotaList) MarshalTo(dAtA []byte) (int, error)

                                          func (*ClusterResourceQuotaList) ProtoMessage

                                          func (*ClusterResourceQuotaList) ProtoMessage()

                                          func (*ClusterResourceQuotaList) Reset

                                          func (m *ClusterResourceQuotaList) Reset()

                                          func (*ClusterResourceQuotaList) Size

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

                                          func (*ClusterResourceQuotaList) String

                                          func (this *ClusterResourceQuotaList) String() string

                                          func (ClusterResourceQuotaList) SwaggerDoc

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

                                          func (*ClusterResourceQuotaList) Unmarshal

                                          func (m *ClusterResourceQuotaList) Unmarshal(dAtA []byte) error

                                          type ClusterResourceQuotaSelector

                                          type ClusterResourceQuotaSelector struct {
                                          	// LabelSelector is used to select projects by label.
                                          	LabelSelector *metav1.LabelSelector `json:"labels" protobuf:"bytes,1,opt,name=labels"`
                                          
                                          	// AnnotationSelector is used to select projects by annotation.
                                          	AnnotationSelector map[string]string `json:"annotations" protobuf:"bytes,2,rep,name=annotations"`
                                          }

                                            ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.

                                            func (*ClusterResourceQuotaSelector) DeepCopy

                                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterResourceQuotaSelector.

                                              func (*ClusterResourceQuotaSelector) DeepCopyInto

                                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                func (*ClusterResourceQuotaSelector) Descriptor

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

                                                func (*ClusterResourceQuotaSelector) Marshal

                                                func (m *ClusterResourceQuotaSelector) Marshal() (dAtA []byte, err error)

                                                func (*ClusterResourceQuotaSelector) MarshalTo

                                                func (m *ClusterResourceQuotaSelector) MarshalTo(dAtA []byte) (int, error)

                                                func (*ClusterResourceQuotaSelector) ProtoMessage

                                                func (*ClusterResourceQuotaSelector) ProtoMessage()

                                                func (*ClusterResourceQuotaSelector) Reset

                                                func (m *ClusterResourceQuotaSelector) Reset()

                                                func (*ClusterResourceQuotaSelector) Size

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

                                                func (*ClusterResourceQuotaSelector) String

                                                func (this *ClusterResourceQuotaSelector) String() string

                                                func (ClusterResourceQuotaSelector) SwaggerDoc

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

                                                func (*ClusterResourceQuotaSelector) Unmarshal

                                                func (m *ClusterResourceQuotaSelector) Unmarshal(dAtA []byte) error

                                                type ClusterResourceQuotaSpec

                                                type ClusterResourceQuotaSpec struct {
                                                	// Selector is the selector used to match projects.
                                                	// It should only select active projects on the scale of dozens (though it can select
                                                	// many more less active projects).  These projects will contend on object creation through
                                                	// this resource.
                                                	Selector ClusterResourceQuotaSelector `json:"selector" protobuf:"bytes,1,opt,name=selector"`
                                                
                                                	// Quota defines the desired quota
                                                	Quota corev1.ResourceQuotaSpec `json:"quota" protobuf:"bytes,2,opt,name=quota"`
                                                }

                                                  ClusterResourceQuotaSpec defines the desired quota restrictions

                                                  func (*ClusterResourceQuotaSpec) DeepCopy

                                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterResourceQuotaSpec.

                                                    func (*ClusterResourceQuotaSpec) DeepCopyInto

                                                    func (in *ClusterResourceQuotaSpec) DeepCopyInto(out *ClusterResourceQuotaSpec)

                                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                      func (*ClusterResourceQuotaSpec) Descriptor

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

                                                      func (*ClusterResourceQuotaSpec) Marshal

                                                      func (m *ClusterResourceQuotaSpec) Marshal() (dAtA []byte, err error)

                                                      func (*ClusterResourceQuotaSpec) MarshalTo

                                                      func (m *ClusterResourceQuotaSpec) MarshalTo(dAtA []byte) (int, error)

                                                      func (*ClusterResourceQuotaSpec) ProtoMessage

                                                      func (*ClusterResourceQuotaSpec) ProtoMessage()

                                                      func (*ClusterResourceQuotaSpec) Reset

                                                      func (m *ClusterResourceQuotaSpec) Reset()

                                                      func (*ClusterResourceQuotaSpec) Size

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

                                                      func (*ClusterResourceQuotaSpec) String

                                                      func (this *ClusterResourceQuotaSpec) String() string

                                                      func (ClusterResourceQuotaSpec) SwaggerDoc

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

                                                      func (*ClusterResourceQuotaSpec) Unmarshal

                                                      func (m *ClusterResourceQuotaSpec) Unmarshal(dAtA []byte) error

                                                      type ClusterResourceQuotaStatus

                                                      type ClusterResourceQuotaStatus struct {
                                                      	// Total defines the actual enforced quota and its current usage across all projects
                                                      	Total corev1.ResourceQuotaStatus `json:"total" protobuf:"bytes,1,opt,name=total"`
                                                      
                                                      	// Namespaces slices the usage by project.  This division allows for quick resolution of
                                                      	// deletion reconciliation inside of a single project without requiring a recalculation
                                                      	// across all projects.  This can be used to pull the deltas for a given project.
                                                      	Namespaces ResourceQuotasStatusByNamespace `json:"namespaces" protobuf:"bytes,2,rep,name=namespaces"`
                                                      }

                                                        ClusterResourceQuotaStatus defines the actual enforced quota and its current usage

                                                        func (*ClusterResourceQuotaStatus) DeepCopy

                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterResourceQuotaStatus.

                                                          func (*ClusterResourceQuotaStatus) DeepCopyInto

                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                            func (*ClusterResourceQuotaStatus) Descriptor

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

                                                            func (*ClusterResourceQuotaStatus) Marshal

                                                            func (m *ClusterResourceQuotaStatus) Marshal() (dAtA []byte, err error)

                                                            func (*ClusterResourceQuotaStatus) MarshalTo

                                                            func (m *ClusterResourceQuotaStatus) MarshalTo(dAtA []byte) (int, error)

                                                            func (*ClusterResourceQuotaStatus) ProtoMessage

                                                            func (*ClusterResourceQuotaStatus) ProtoMessage()

                                                            func (*ClusterResourceQuotaStatus) Reset

                                                            func (m *ClusterResourceQuotaStatus) Reset()

                                                            func (*ClusterResourceQuotaStatus) Size

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

                                                            func (*ClusterResourceQuotaStatus) String

                                                            func (this *ClusterResourceQuotaStatus) String() string

                                                            func (ClusterResourceQuotaStatus) SwaggerDoc

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

                                                            func (*ClusterResourceQuotaStatus) Unmarshal

                                                            func (m *ClusterResourceQuotaStatus) Unmarshal(dAtA []byte) error

                                                            type ResourceQuotaStatusByNamespace

                                                            type ResourceQuotaStatusByNamespace struct {
                                                            	// Namespace the project this status applies to
                                                            	Namespace string `json:"namespace" protobuf:"bytes,1,opt,name=namespace"`
                                                            
                                                            	// Status indicates how many resources have been consumed by this project
                                                            	Status corev1.ResourceQuotaStatus `json:"status" protobuf:"bytes,2,opt,name=status"`
                                                            }

                                                              ResourceQuotaStatusByNamespace gives status for a particular project

                                                              func (*ResourceQuotaStatusByNamespace) DeepCopy

                                                                DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceQuotaStatusByNamespace.

                                                                func (*ResourceQuotaStatusByNamespace) DeepCopyInto

                                                                  DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                  func (*ResourceQuotaStatusByNamespace) Descriptor

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

                                                                  func (*ResourceQuotaStatusByNamespace) Marshal

                                                                  func (m *ResourceQuotaStatusByNamespace) Marshal() (dAtA []byte, err error)

                                                                  func (*ResourceQuotaStatusByNamespace) MarshalTo

                                                                  func (m *ResourceQuotaStatusByNamespace) MarshalTo(dAtA []byte) (int, error)

                                                                  func (*ResourceQuotaStatusByNamespace) ProtoMessage

                                                                  func (*ResourceQuotaStatusByNamespace) ProtoMessage()

                                                                  func (*ResourceQuotaStatusByNamespace) Reset

                                                                  func (m *ResourceQuotaStatusByNamespace) Reset()

                                                                  func (*ResourceQuotaStatusByNamespace) Size

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

                                                                  func (*ResourceQuotaStatusByNamespace) String

                                                                  func (this *ResourceQuotaStatusByNamespace) String() string

                                                                  func (ResourceQuotaStatusByNamespace) SwaggerDoc

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

                                                                  func (*ResourceQuotaStatusByNamespace) Unmarshal

                                                                  func (m *ResourceQuotaStatusByNamespace) Unmarshal(dAtA []byte) error

                                                                  type ResourceQuotasStatusByNamespace

                                                                  type ResourceQuotasStatusByNamespace []ResourceQuotaStatusByNamespace

                                                                    ResourceQuotasStatusByNamespace bundles multiple ResourceQuotaStatusByNamespace

                                                                    func (*ResourceQuotasStatusByNamespace) DeepCopy

                                                                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceQuotasStatusByNamespace.

                                                                      func (*ResourceQuotasStatusByNamespace) DeepCopyInto

                                                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.