Search

Chapter 6. PriorityClass [scheduling.k8s.io/v1]

download PDF
Description
PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.
Type
object
Required
  • value

6.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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.

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

preemptionPolicy

string

preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.

Possible enum values: - "Never" means that pod never preempts other pods with lower priority. - "PreemptLowerPriority" means that pod can preempt other pods with lower priority.

value

integer

value represents the integer 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.

6.2. API endpoints

The following API endpoints are available:

  • /apis/scheduling.k8s.io/v1/priorityclasses

    • DELETE: delete collection of PriorityClass
    • GET: list or watch objects of kind PriorityClass
    • POST: create a PriorityClass
  • /apis/scheduling.k8s.io/v1/watch/priorityclasses

    • GET: watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/scheduling.k8s.io/v1/priorityclasses/{name}

    • DELETE: delete a PriorityClass
    • GET: read the specified PriorityClass
    • PATCH: partially update the specified PriorityClass
    • PUT: replace the specified PriorityClass
  • /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}

    • GET: watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

6.2.1. /apis/scheduling.k8s.io/v1/priorityclasses

HTTP method
DELETE
Description
delete collection of PriorityClass
Table 6.1. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 6.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind PriorityClass
Table 6.3. HTTP responses
HTTP codeReponse body

200 - OK

PriorityClassList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a PriorityClass
Table 6.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.5. Body parameters
ParameterTypeDescription

body

PriorityClass schema

 
Table 6.6. HTTP responses
HTTP codeReponse body

200 - OK

PriorityClass schema

201 - Created

PriorityClass schema

202 - Accepted

PriorityClass schema

401 - Unauthorized

Empty

6.2.2. /apis/scheduling.k8s.io/v1/watch/priorityclasses

HTTP method
GET
Description
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
Table 6.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

6.2.3. /apis/scheduling.k8s.io/v1/priorityclasses/{name}

Table 6.8. Global path parameters
ParameterTypeDescription

name

string

name of the PriorityClass

HTTP method
DELETE
Description
delete a PriorityClass
Table 6.9. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 6.10. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified PriorityClass
Table 6.11. HTTP responses
HTTP codeReponse body

200 - OK

PriorityClass schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified PriorityClass
Table 6.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.13. HTTP responses
HTTP codeReponse body

200 - OK

PriorityClass schema

201 - Created

PriorityClass schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified PriorityClass
Table 6.14. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 6.15. Body parameters
ParameterTypeDescription

body

PriorityClass schema

 
Table 6.16. HTTP responses
HTTP codeReponse body

200 - OK

PriorityClass schema

201 - Created

PriorityClass schema

401 - Unauthorized

Empty

6.2.4. /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}

Table 6.17. Global path parameters
ParameterTypeDescription

name

string

name of the PriorityClass

HTTP method
GET
Description
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Table 6.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.