Fork me on GitHub

Module batch/v1

@pulumi/kubernetes > batch > v1

Index

types/input.ts types/output.ts

function isJob

isJob(o: any): boolean

function isJobList

isJobList(o: any): boolean

interface Job

Job represents the configuration of a single job.

property apiVersion

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/api-conventions.md#resources

property kind

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

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

property spec

spec: JobSpec;

Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

property status

status: JobStatus;

Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

interface JobCondition

JobCondition describes current state of a job.

property lastProbeTime

lastProbeTime: string;

Last time the condition was checked.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transit from one status to another.

property message

message: string;

Human readable message indicating details about last transition.

property reason

reason: string;

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

property status

status: string;

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

property type

type: string;

Type of job condition, Complete or Failed.

interface JobList

JobList is a collection of jobs.

property apiVersion

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/api-conventions.md#resources

property items

items: Job[];

items is the list of Jobs.

property kind

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/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

interface JobSpec

JobSpec describes how the job execution will look like.

property activeDeadlineSeconds

activeDeadlineSeconds: number;

Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

property backoffLimit

backoffLimit: number;

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

property completions

completions: number;

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil 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/

property manualSelector

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

property parallelism

parallelism: number;

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/

property selector

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

property template

template: PodTemplateSpec;

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

interface JobStatus

JobStatus represents the current state of a Job.

property active

active: number;

The number of actively running pods.

property completionTime

completionTime: string;

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.

property conditions

conditions: JobCondition[];

The latest available observations of an object’s current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

property failed

failed: number;

The number of pods which reached phase Failed.

property startTime

startTime: string;

Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

property succeeded

succeeded: number;

The number of pods which reached phase Succeeded.