2 Copyright 2017 The Kubernetes Authors.
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
8 http://www.apache.org/licenses/LICENSE-2.0
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
20 metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
24 // +genclient:nonNamespaced
25 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
27 // PriorityClass defines mapping from a priority class name to the priority
28 // integer value. The value can be any valid integer.
29 type PriorityClass struct {
30 metav1.TypeMeta `json:",inline"`
31 // Standard object's metadata.
32 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
34 metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
36 // The value of this priority class. This is the actual priority that pods
37 // receive when they have the name of this class in their pod spec.
38 Value int32 `json:"value" protobuf:"bytes,2,opt,name=value"`
40 // globalDefault specifies whether this PriorityClass should be considered as
41 // the default priority for pods that do not have any priority class.
42 // Only one PriorityClass can be marked as `globalDefault`. However, if more than
43 // one PriorityClasses exists with their `globalDefault` field set to true,
44 // the smallest value of such global default PriorityClasses will be used as the default priority.
46 GlobalDefault bool `json:"globalDefault,omitempty" protobuf:"bytes,3,opt,name=globalDefault"`
48 // description is an arbitrary string that usually provides guidelines on
49 // when this priority class should be used.
51 Description string `json:"description,omitempty" protobuf:"bytes,4,opt,name=description"`
54 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
56 // PriorityClassList is a collection of priority classes.
57 type PriorityClassList struct {
58 metav1.TypeMeta `json:",inline"`
59 // Standard list metadata
60 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
62 metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
64 // items is the list of PriorityClasses
65 Items []PriorityClass `json:"items" protobuf:"bytes,2,rep,name=items"`