kubernetes: k8s.io/kubernetes/pkg/apis/batch Index | Files | Directories

package batch

import "k8s.io/kubernetes/pkg/apis/batch"

Index

Package Files

doc.go register.go types.go zz_generated.deepcopy.go

Constants

const GroupName = "batch"

GroupName is the group name use in this package

Variables

var (
    // SchemeBuilder points to a list of functions added to Scheme.
    SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    // AddToScheme applies all the stored functions to the scheme.
    AddToScheme = SchemeBuilder.AddToScheme
)
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

func Kind Uses

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

type ConcurrencyPolicy Uses

type ConcurrencyPolicy string

ConcurrencyPolicy describes how the job will be handled. Only one of the following concurrent policies may be specified. If none of the following policies is specified, the default one is AllowConcurrent.

const (
    // AllowConcurrent allows CronJobs to run concurrently.
    AllowConcurrent ConcurrencyPolicy = "Allow"

    // ForbidConcurrent forbids concurrent runs, skipping next run if previous
    // hasn't finished yet.
    ForbidConcurrent ConcurrencyPolicy = "Forbid"

    // ReplaceConcurrent cancels currently running job and replaces it with a new one.
    ReplaceConcurrent ConcurrencyPolicy = "Replace"
)

type CronJob Uses

type CronJob struct {
    metav1.TypeMeta
    // Standard object's metadata.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ObjectMeta

    // Specification of the desired behavior of a cron job, including the schedule.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
    // +optional
    Spec CronJobSpec

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

CronJob represents the configuration of a single cron job.

func (*CronJob) DeepCopy Uses

func (in *CronJob) DeepCopy() *CronJob

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJob.

func (*CronJob) DeepCopyInto Uses

func (in *CronJob) DeepCopyInto(out *CronJob)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CronJob) DeepCopyObject Uses

func (in *CronJob) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CronJobList Uses

type CronJobList struct {
    metav1.TypeMeta
    // Standard list metadata.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ListMeta

    // items is the list of CronJobs.
    Items []CronJob
}

CronJobList is a collection of cron jobs.

func (*CronJobList) DeepCopy Uses

func (in *CronJobList) DeepCopy() *CronJobList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobList.

func (*CronJobList) DeepCopyInto Uses

func (in *CronJobList) DeepCopyInto(out *CronJobList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CronJobList) DeepCopyObject Uses

func (in *CronJobList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CronJobSpec Uses

type CronJobSpec struct {

    // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    Schedule string

    // Optional deadline in seconds for starting the job if it misses scheduled
    // time for any reason.  Missed jobs executions will be counted as failed ones.
    // +optional
    StartingDeadlineSeconds *int64

    // Specifies how to treat concurrent executions of a Job.
    // Valid values are:
    // - "Allow" (default): allows CronJobs to run concurrently;
    // - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
    // - "Replace": cancels currently running job and replaces it with a new one
    // +optional
    ConcurrencyPolicy ConcurrencyPolicy

    // This flag tells the controller to suspend subsequent executions, it does
    // not apply to already started executions.  Defaults to false.
    // +optional
    Suspend *bool

    // Specifies the job that will be created when executing a CronJob.
    JobTemplate JobTemplateSpec

    // The number of successful finished jobs to retain.
    // This is a pointer to distinguish between explicit zero and not specified.
    // +optional
    SuccessfulJobsHistoryLimit *int32

    // The number of failed finished jobs to retain.
    // This is a pointer to distinguish between explicit zero and not specified.
    // +optional
    FailedJobsHistoryLimit *int32
}

CronJobSpec describes how the job execution will look like and when it will actually run.

func (*CronJobSpec) DeepCopy Uses

func (in *CronJobSpec) DeepCopy() *CronJobSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobSpec.

func (*CronJobSpec) DeepCopyInto Uses

func (in *CronJobSpec) DeepCopyInto(out *CronJobSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CronJobStatus Uses

type CronJobStatus struct {
    // A list of pointers to currently running jobs.
    // +optional
    Active []api.ObjectReference

    // Information when was the last time the job was successfully scheduled.
    // +optional
    LastScheduleTime *metav1.Time
}

CronJobStatus represents the current state of a cron job.

func (*CronJobStatus) DeepCopy Uses

func (in *CronJobStatus) DeepCopy() *CronJobStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobStatus.

func (*CronJobStatus) DeepCopyInto Uses

func (in *CronJobStatus) DeepCopyInto(out *CronJobStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Job Uses

type Job struct {
    metav1.TypeMeta
    // Standard object's metadata.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ObjectMeta

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

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

Job represents the configuration of a single job.

func (*Job) DeepCopy Uses

func (in *Job) DeepCopy() *Job

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Job.

func (*Job) DeepCopyInto Uses

func (in *Job) DeepCopyInto(out *Job)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Job) DeepCopyObject Uses

func (in *Job) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type JobCondition Uses

type JobCondition struct {
    // Type of job condition, Complete or Failed.
    Type JobConditionType
    // Status of the condition, one of True, False, Unknown.
    Status api.ConditionStatus
    // Last time the condition was checked.
    // +optional
    LastProbeTime metav1.Time
    // Last time the condition transit from one status to another.
    // +optional
    LastTransitionTime metav1.Time
    // (brief) reason for the condition's last transition.
    // +optional
    Reason string
    // Human readable message indicating details about last transition.
    // +optional
    Message string
}

JobCondition describes current state of a job.

func (*JobCondition) DeepCopy Uses

func (in *JobCondition) DeepCopy() *JobCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobCondition.

func (*JobCondition) DeepCopyInto Uses

func (in *JobCondition) DeepCopyInto(out *JobCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobConditionType Uses

type JobConditionType string

JobConditionType is a valid value for JobCondition.Type

const (
    // JobComplete means the job has completed its execution.
    JobComplete JobConditionType = "Complete"
    // JobFailed means the job has failed its execution.
    JobFailed JobConditionType = "Failed"
)

These are valid conditions of a job.

type JobList Uses

type JobList struct {
    metav1.TypeMeta
    // Standard list metadata.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ListMeta

    // items is the list of Jobs.
    Items []Job
}

JobList is a collection of jobs.

func (*JobList) DeepCopy Uses

func (in *JobList) DeepCopy() *JobList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobList.

func (*JobList) DeepCopyInto Uses

func (in *JobList) DeepCopyInto(out *JobList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobList) DeepCopyObject Uses

func (in *JobList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type JobSpec Uses

type JobSpec struct {

    // 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.
    // +optional
    Parallelism *int32

    // 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.
    // +optional
    Completions *int32

    // Optional 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
    // +optional
    ActiveDeadlineSeconds *int64

    // Optional number of retries before marking this job failed.
    // Defaults to 6
    // +optional
    BackoffLimit *int32

    // A label query over pods that should match the pod count.
    // Normally, the system sets this field for you.
    // +optional
    Selector *metav1.LabelSelector

    // 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.
    // +optional
    ManualSelector *bool

    // Describes the pod that will be created when executing a job.
    Template api.PodTemplateSpec

    // 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.
    // This field is alpha-level and is only honored by servers that enable the
    // TTLAfterFinished feature.
    // +optional
    TTLSecondsAfterFinished *int32
}

JobSpec describes how the job execution will look like.

func (*JobSpec) DeepCopy Uses

func (in *JobSpec) DeepCopy() *JobSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSpec.

func (*JobSpec) DeepCopyInto Uses

func (in *JobSpec) DeepCopyInto(out *JobSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobStatus Uses

type JobStatus struct {

    // The latest available observations of an object's current state.
    // +optional
    Conditions []JobCondition

    // 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.
    // +optional
    StartTime *metav1.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.
    // +optional
    CompletionTime *metav1.Time

    // The number of actively running pods.
    // +optional
    Active int32

    // The number of pods which reached phase Succeeded.
    // +optional
    Succeeded int32

    // The number of pods which reached phase Failed.
    // +optional
    Failed int32
}

JobStatus represents the current state of a Job.

func (*JobStatus) DeepCopy Uses

func (in *JobStatus) DeepCopy() *JobStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobStatus.

func (*JobStatus) DeepCopyInto Uses

func (in *JobStatus) DeepCopyInto(out *JobStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type JobTemplate Uses

type JobTemplate struct {
    metav1.TypeMeta
    // Standard object's metadata.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ObjectMeta

    // Defines jobs that will be created from this template.
    // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
    // +optional
    Template JobTemplateSpec
}

JobTemplate describes a template for creating copies of a predefined pod.

func (*JobTemplate) DeepCopy Uses

func (in *JobTemplate) DeepCopy() *JobTemplate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobTemplate.

func (*JobTemplate) DeepCopyInto Uses

func (in *JobTemplate) DeepCopyInto(out *JobTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobTemplate) DeepCopyObject Uses

func (in *JobTemplate) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type JobTemplateSpec Uses

type JobTemplateSpec struct {
    // Standard object's metadata of the jobs created from this template.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    // +optional
    metav1.ObjectMeta

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

JobTemplateSpec describes the data a Job should have when created from a template

func (*JobTemplateSpec) DeepCopy Uses

func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobTemplateSpec.

func (*JobTemplateSpec) DeepCopyInto Uses

func (in *JobTemplateSpec) DeepCopyInto(out *JobTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Directories

PathSynopsis
fuzzer
installPackage install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery.
v1
v1beta1
v2alpha1
validation

Package batch imports 4 packages (graph) and is imported by 1268 packages. Updated 2019-06-19. Refresh now. Tools for package owners.