Job [batch/v1]

Description

Job represents the configuration of a single job.

Type

object

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

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

spec

object

JobSpec describes how the job execution will look like.

status

object

JobStatus represents the current state of a Job.

.spec

Description

JobSpec describes how the job execution will look like.

Type

object

Required

  • template
PropertyTypeDescription

activeDeadlineSeconds

integer

Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

backoffLimit

integer

Specifies the number of retries before marking this job failed. Defaults to 6

backoffLimitPerIndex

integer

Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod’s batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job’s completionMode=Indexed, and the Pod’s restart policy is Never. The field is immutable. This field is alpha-level. It can be used when the JobBackoffLimitPerIndex feature gate is enabled (disabled by default).

completionMode

string

completionMode specifies how Pod completions are tracked. It can be NonIndexed (default) or Indexed.

NonIndexed means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.

Indexed means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is Indexed, .spec.completions must be specified and .spec.parallelism must be less than or equal to 10^5. In addition, The Pod name takes the form $(job-name)-$(index)-$(random-string), the Pod hostname takes the form $(job-name)-$(index).

More completion modes can be added in the future. If the Job controller observes a mode that it doesn’t recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

Possible enum values: - “Indexed” is a Job completion mode. In this mode, the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1). The Job is considered complete when a Pod completes for each completion index. - “NonIndexed” is a Job completion mode. In this mode, the Job is considered complete when there have been .spec.completions successfully completed Pods. Pod completions are homologous to each other.

completions

integer

Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

manualSelector

boolean

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

maxFailedIndexes

integer

Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the Complete Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is alpha-level. It can be used when the JobBackoffLimitPerIndex feature gate is enabled (disabled by default).

parallelism

integer

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

podFailurePolicy

object

PodFailurePolicy describes how failed pods influence the backoffLimit.

podReplacementPolicy

string

podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod.

When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an alpha field. Enable JobPodReplacementPolicy to be able to use this field.

Possible enum values: - “Failed” means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. - “TerminatingOrFailed” means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed.

selector

LabelSelector

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

suspend

boolean

suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.

template

PodTemplateSpec

Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are “Never” or “OnFailure”. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

ttlSecondsAfterFinished

integer

ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won’t be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

.spec.podFailurePolicy

Description

PodFailurePolicy describes how failed pods influence the backoffLimit.

Type

object

Required

  • rules
PropertyTypeDescription

rules

array

A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.

rules[]

object

PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.

.spec.podFailurePolicy.rules

Description

A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.

Type

array

.spec.podFailurePolicy.rules[]

Description

PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.

Type

object

Required

  • action
PropertyTypeDescription

action

string

Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:

- FailJob: indicates that the pod’s job is marked as Failed and all running pods are terminated. - FailIndex: indicates that the pod’s index is marked as Failed and will not be restarted. This value is alpha-level. It can be used when the JobBackoffLimitPerIndex feature gate is enabled (disabled by default). - Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created. - Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.

Possible enum values: - “Count” This is an action which might be taken on a pod failure - the pod failure is handled in the default way - the counter towards .backoffLimit, represented by the job’s .status.failed field, is incremented. - “FailIndex” This is an action which might be taken on a pod failure - mark the Job’s index as failed to avoid restarts within this index. This action can only be used when backoffLimitPerIndex is set. - “FailJob” This is an action which might be taken on a pod failure - mark the pod’s job as Failed and terminate all running pods. - “Ignore” This is an action which might be taken on a pod failure - the counter towards .backoffLimit, represented by the job’s .status.failed field, is not incremented and a replacement pod is created.

onExitCodes

object

PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.

onPodConditions

array

Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.

onPodConditions[]

object

PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.

.spec.podFailurePolicy.rules[].onExitCodes

Description

PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.

Type

object

Required

  • operator

  • values

PropertyTypeDescription

containerName

string

Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.

operator

string

Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are:

- In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the ‘containerName’ field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.

Possible enum values: - “In” - “NotIn”

values

array (integer)

Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value ‘0’ cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.

.spec.podFailurePolicy.rules[].onPodConditions

Description

Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.

Type

array

.spec.podFailurePolicy.rules[].onPodConditions[]

Description

PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.

Type

object

Required

  • type

  • status

PropertyTypeDescription

status

string

Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.

type

string

Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.

.status

Description

JobStatus represents the current state of a Job.

Type

object

PropertyTypeDescription

active

integer

The number of pending and running pods.

completedIndexes

string

completedIndexes holds the completed indexes when .spec.completionMode = “Indexed” in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as “1,3-5,7”.

completionTime

Time

Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully.

conditions

array

The latest available observations of an object’s current state. When a Job fails, one of the conditions will have type “Failed” and status true. When a Job is suspended, one of the conditions will have type “Suspended” and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type “Complete” and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

conditions[]

object

JobCondition describes current state of a job.

failed

integer

The number of pods which reached phase Failed.

failedIndexes

string

FailedIndexes holds the failed indexes when backoffLimitPerIndex=true. The indexes are represented in the text format analogous as for the completedIndexes field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as “1,3-5,7”. This field is alpha-level. It can be used when the JobBackoffLimitPerIndex feature gate is enabled (disabled by default).

ready

integer

The number of pods which have a Ready condition.

This field is beta-level. The job controller populates the field when the feature gate JobReadyPods is enabled (enabled by default).

startTime

Time

Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.

succeeded

integer

The number of pods which reached phase Succeeded.

terminating

integer

The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).

This field is alpha-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (disabled by default).

uncountedTerminatedPods

object

UncountedTerminatedPods holds UIDs of Pods that have terminated but haven’t been accounted in Job status counters.

.status.conditions

Description

The latest available observations of an object’s current state. When a Job fails, one of the conditions will have type “Failed” and status true. When a Job is suspended, one of the conditions will have type “Suspended” and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type “Complete” and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

Type

array

.status.conditions[]

Description

JobCondition describes current state of a job.

Type

object

Required

  • type

  • status

PropertyTypeDescription

lastProbeTime

Time

Last time the condition was checked.

lastTransitionTime

Time

Last time the condition transit from one status to another.

message

string

Human readable message indicating details about last transition.

reason

string

(brief) reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of job condition, Complete or Failed.

.status.uncountedTerminatedPods

Description

UncountedTerminatedPods holds UIDs of Pods that have terminated but haven’t been accounted in Job status counters.

Type

object

PropertyTypeDescription

failed

array (string)

failed holds UIDs of failed Pods.

succeeded

array (string)

succeeded holds UIDs of succeeded Pods.

API endpoints

The following API endpoints are available:

  • /apis/batch/v1/jobs

    • GET: list or watch objects of kind Job
  • /apis/batch/v1/watch/jobs

    • GET: watch individual changes to a list of Job. deprecated: use the ‘watch’ parameter with a list operation instead.
  • /apis/batch/v1/namespaces/{namespace}/jobs

    • DELETE: delete collection of Job

    • GET: list or watch objects of kind Job

    • POST: create a Job

  • /apis/batch/v1/watch/namespaces/{namespace}/jobs

    • GET: watch individual changes to a list of Job. deprecated: use the ‘watch’ parameter with a list operation instead.
  • /apis/batch/v1/namespaces/{namespace}/jobs/{name}

    • DELETE: delete a Job

    • GET: read the specified Job

    • PATCH: partially update the specified Job

    • PUT: replace the specified Job

  • /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

    • GET: watch changes to an object of kind Job. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.
  • /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

    • GET: read status of the specified Job

    • PATCH: partially update status of the specified Job

    • PUT: replace status of the specified Job

/apis/batch/v1/jobs

HTTP method

GET

Description

list or watch objects of kind Job

Table 1. HTTP responses
HTTP codeReponse body

200 - OK

JobList schema

401 - Unauthorized

Empty

/apis/batch/v1/watch/jobs

HTTP method

GET

Description

watch individual changes to a list of Job. deprecated: use the ‘watch’ parameter with a list operation instead.

Table 2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/batch/v1/namespaces/{namespace}/jobs

HTTP method

DELETE

Description

delete collection of Job

Table 3. 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 4. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind Job

Table 5. HTTP responses
HTTP codeReponse body

200 - OK

JobList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a Job

Table 6. 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 7. Body parameters
ParameterTypeDescription

body

Job schema

Table 8. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

201 - Created

Job schema

202 - Accepted

Job schema

401 - Unauthorized

Empty

/apis/batch/v1/watch/namespaces/{namespace}/jobs

HTTP method

GET

Description

watch individual changes to a list of Job. deprecated: use the ‘watch’ parameter with a list operation instead.

Table 9. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/batch/v1/namespaces/{namespace}/jobs/{name}

Table 10. Global path parameters
ParameterTypeDescription

name

string

name of the Job

HTTP method

DELETE

Description

delete a Job

Table 11. 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 12. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified Job

Table 13. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified Job

Table 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 15. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

201 - Created

Job schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified Job

Table 16. 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 17. Body parameters
ParameterTypeDescription

body

Job schema

Table 18. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

201 - Created

Job schema

401 - Unauthorized

Empty

/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}

Table 19. Global path parameters
ParameterTypeDescription

name

string

name of the Job

HTTP method

GET

Description

watch changes to an object of kind Job. deprecated: use the ‘watch’ parameter with a list operation instead, filtered to a single item with the ‘fieldSelector’ parameter.

Table 20. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status

Table 21. Global path parameters
ParameterTypeDescription

name

string

name of the Job

HTTP method

GET

Description

read status of the specified Job

Table 22. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified Job

Table 23. 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 24. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

201 - Created

Job schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified Job

Table 25. 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 26. Body parameters
ParameterTypeDescription

body

Job schema

Table 27. HTTP responses
HTTP codeReponse body

200 - OK

Job schema

201 - Created

Job schema

401 - Unauthorized

Empty