--- api_metadata: apiVersion: "scheduling.k8s.io/v1" import: "k8s.io/api/scheduling/v1" kind: "PriorityClass" content_type: "api_reference" description: "PriorityClass defines mapping from a priority class name to the priority integer value." title: "PriorityClass" weight: 14 auto_generated: true --- <!-- The file is auto-generated from the Go source code of the component using a generic [generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how to generate the reference documentation, please read [Contributing to the reference documentation](/docs/contribute/generate-ref-docs/). To update the reference content, please follow the [Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/) guide. You can file document formatting bugs against the [reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project. --> `apiVersion: scheduling.k8s.io/v1` `import "k8s.io/api/scheduling/v1"` ## PriorityClass {#PriorityClass} PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. <hr> - **apiVersion**: scheduling.k8s.io/v1 - **kind**: PriorityClass - **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **value** (int32), required The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. - **description** (string) description is an arbitrary string that usually provides guidelines on when this priority class should be used. - **globalDefault** (boolean) globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. - **preemptionPolicy** (string) PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. ## PriorityClassList {#PriorityClassList} PriorityClassList is a collection of priority classes. <hr> - **apiVersion**: scheduling.k8s.io/v1 - **kind**: PriorityClassList - **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>) Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>), required items is the list of PriorityClasses ## Operations {#Operations} <hr> ### `get` read the specified PriorityClass #### HTTP Request GET /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Parameters - **name** (*in path*): string, required name of the PriorityClass - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> #### Response 200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK 401: Unauthorized ### `list` list or watch objects of kind PriorityClass #### HTTP Request GET /apis/scheduling.k8s.io/v1/priorityclasses #### Parameters - **allowWatchBookmarks** (*in query*): boolean <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a> - **continue** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a> - **fieldSelector** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a> - **labelSelector** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a> - **limit** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> - **resourceVersion** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a> - **resourceVersionMatch** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a> - **timeoutSeconds** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a> - **watch** (*in query*): boolean <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a> #### Response 200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClassList" >}}">PriorityClassList</a>): OK 401: Unauthorized ### `create` create a PriorityClass #### HTTP Request POST /apis/scheduling.k8s.io/v1/priorityclasses #### Parameters - **body**: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required - **dryRun** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a> - **fieldManager** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a> - **fieldValidation** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> #### Response 200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK 201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created 202 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Accepted 401: Unauthorized ### `update` replace the specified PriorityClass #### HTTP Request PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Parameters - **name** (*in path*): string, required name of the PriorityClass - **body**: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required - **dryRun** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a> - **fieldManager** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a> - **fieldValidation** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> #### Response 200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK 201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created 401: Unauthorized ### `patch` partially update the specified PriorityClass #### HTTP Request PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Parameters - **name** (*in path*): string, required name of the PriorityClass - **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required - **dryRun** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a> - **fieldManager** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a> - **fieldValidation** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a> - **force** (*in query*): boolean <a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> #### Response 200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK 201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created 401: Unauthorized ### `delete` delete a PriorityClass #### HTTP Request DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Parameters - **name** (*in path*): string, required name of the PriorityClass - **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a> - **dryRun** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a> - **gracePeriodSeconds** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> - **propagationPolicy** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a> #### Response 200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK 202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): Accepted 401: Unauthorized ### `deletecollection` delete collection of PriorityClass #### HTTP Request DELETE /apis/scheduling.k8s.io/v1/priorityclasses #### Parameters - **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a> - **continue** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a> - **dryRun** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a> - **fieldSelector** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a> - **gracePeriodSeconds** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a> - **labelSelector** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a> - **limit** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a> - **pretty** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a> - **propagationPolicy** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a> - **resourceVersion** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a> - **resourceVersionMatch** (*in query*): string <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a> - **timeoutSeconds** (*in query*): integer <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a> #### Response 200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK 401: Unauthorized