batch

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2016 License: Apache-2.0, Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const GroupName = "batch"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func AddToScheme 

func AddToScheme(scheme *runtime.Scheme)

func DeepCopy_batch_Job 

func DeepCopy_batch_Job(in Job, out *Job, c *conversion.Cloner) error

func DeepCopy_batch_JobCondition 

func DeepCopy_batch_JobCondition(in JobCondition, out *JobCondition, c *conversion.Cloner) error

func DeepCopy_batch_JobList 

func DeepCopy_batch_JobList(in JobList, out *JobList, c *conversion.Cloner) error

func DeepCopy_batch_JobSpec 

func DeepCopy_batch_JobSpec(in JobSpec, out *JobSpec, c *conversion.Cloner) error

func DeepCopy_batch_JobStatus 

func DeepCopy_batch_JobStatus(in JobStatus, out *JobStatus, c *conversion.Cloner) error

func DeepCopy_batch_JobTemplate 

func DeepCopy_batch_JobTemplate(in JobTemplate, out *JobTemplate, c *conversion.Cloner) error

func DeepCopy_batch_JobTemplateSpec 

func DeepCopy_batch_JobTemplateSpec(in JobTemplateSpec, out *JobTemplateSpec, c *conversion.Cloner) error

func DeepCopy_batch_ScheduledJob 

func DeepCopy_batch_ScheduledJob(in ScheduledJob, out *ScheduledJob, c *conversion.Cloner) error

func DeepCopy_batch_ScheduledJobList 

func DeepCopy_batch_ScheduledJobList(in ScheduledJobList, out *ScheduledJobList, c *conversion.Cloner) error

func DeepCopy_batch_ScheduledJobSpec 

func DeepCopy_batch_ScheduledJobSpec(in ScheduledJobSpec, out *ScheduledJobSpec, c *conversion.Cloner) error

func DeepCopy_batch_ScheduledJobStatus 

func DeepCopy_batch_ScheduledJobStatus(in ScheduledJobStatus, out *ScheduledJobStatus, c *conversion.Cloner) error

func Kind 

func Kind(kind string) unversioned.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) unversioned.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type ConcurrencyPolicy 

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 ScheduledJobs 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"
)

func (*ConcurrencyPolicy) CodecDecodeSelf 

func (x *ConcurrencyPolicy) CodecDecodeSelf(d *codec1978.Decoder)

func (ConcurrencyPolicy) CodecEncodeSelf 

func (x ConcurrencyPolicy) CodecEncodeSelf(e *codec1978.Encoder)

type Job 

type Job struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	api.ObjectMeta `json:"metadata,omitempty"`

	// Spec is a structure defining the expected behavior of a job.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Spec JobSpec `json:"spec,omitempty"`

	// Status is a structure describing current status of a job.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Status JobStatus `json:"status,omitempty"`
}

Job represents the configuration of a single job.

func (*Job) CodecDecodeSelf 

func (x *Job) CodecDecodeSelf(d *codec1978.Decoder)

func (*Job) CodecEncodeSelf 

func (x *Job) CodecEncodeSelf(e *codec1978.Encoder)

func (*Job) GetObjectKind 

func (obj *Job) GetObjectKind() unversioned.ObjectKind

type JobCondition 

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

JobCondition describes current state of a job.

func (*JobCondition) CodecDecodeSelf 

func (x *JobCondition) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobCondition) CodecEncodeSelf 

func (x *JobCondition) CodecEncodeSelf(e *codec1978.Encoder)

type JobConditionType 

type JobConditionType string
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.

func (*JobConditionType) CodecDecodeSelf 

func (x *JobConditionType) CodecDecodeSelf(d *codec1978.Decoder)

func (JobConditionType) CodecEncodeSelf 

func (x JobConditionType) CodecEncodeSelf(e *codec1978.Encoder)

type JobList 

type JobList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	unversioned.ListMeta `json:"metadata,omitempty"`

	// Items is the list of Job.
	Items []Job `json:"items"`
}

JobList is a collection of jobs.

func (*JobList) CodecDecodeSelf 

func (x *JobList) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobList) CodecEncodeSelf 

func (x *JobList) CodecEncodeSelf(e *codec1978.Encoder)

func (*JobList) GetObjectKind 

func (obj *JobList) GetObjectKind() unversioned.ObjectKind

type JobSpec 

type JobSpec struct {

	// Parallelism 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.
	Parallelism *int32 `json:"parallelism,omitempty"`

	// Completions 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.
	Completions *int32 `json:"completions,omitempty"`

	// 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
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`

	// Selector is a label query over pods that should match the pod count.
	// Normally, the system sets this field for you.
	Selector *unversioned.LabelSelector `json:"selector,omitempty"`

	// 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.
	ManualSelector *bool `json:"manualSelector,omitempty"`

	// Template is the object that describes the pod that will be created when
	// executing a job.
	Template api.PodTemplateSpec `json:"template"`
}

JobSpec describes how the job execution will look like.

func (*JobSpec) CodecDecodeSelf 

func (x *JobSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobSpec) CodecEncodeSelf 

func (x *JobSpec) CodecEncodeSelf(e *codec1978.Encoder)

type JobStatus 

type JobStatus struct {

	// Conditions represent the latest available observations of an object's current state.
	Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// StartTime represents time when the job was acknowledged by the Job Manager.
	// It is not guaranteed to be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	StartTime *unversioned.Time `json:"startTime,omitempty"`

	// CompletionTime 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.
	CompletionTime *unversioned.Time `json:"completionTime,omitempty"`

	// Active is the number of actively running pods.
	Active int32 `json:"active,omitempty"`

	// Succeeded is the number of pods which reached Phase Succeeded.
	Succeeded int32 `json:"succeeded,omitempty"`

	// Failed is the number of pods which reached Phase Failed.
	Failed int32 `json:"failed,omitempty"`
}

JobStatus represents the current state of a Job.

func (*JobStatus) CodecDecodeSelf 

func (x *JobStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobStatus) CodecEncodeSelf 

func (x *JobStatus) CodecEncodeSelf(e *codec1978.Encoder)

type JobTemplate 

type JobTemplate struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	api.ObjectMeta `json:"metadata,omitempty"`

	// Template defines jobs that will be created from this template
	// http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Template JobTemplateSpec `json:"template,omitempty"`
}

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

func (*JobTemplate) CodecDecodeSelf 

func (x *JobTemplate) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobTemplate) CodecEncodeSelf 

func (x *JobTemplate) CodecEncodeSelf(e *codec1978.Encoder)

func (*JobTemplate) GetObjectKind 

func (obj *JobTemplate) GetObjectKind() unversioned.ObjectKind

type JobTemplateSpec 

type JobTemplateSpec struct {
	// Standard object's metadata of the jobs created from this template.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	api.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the job.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Spec JobSpec `json:"spec,omitempty"`
}

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

func (*JobTemplateSpec) CodecDecodeSelf 

func (x *JobTemplateSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*JobTemplateSpec) CodecEncodeSelf 

func (x *JobTemplateSpec) CodecEncodeSelf(e *codec1978.Encoder)

type ScheduledJob 

type ScheduledJob struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	api.ObjectMeta `json:"metadata,omitempty"`

	// Spec is a structure defining the expected behavior of a job, including the schedule.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Spec ScheduledJobSpec `json:"spec,omitempty"`

	// Status is a structure describing current status of a job.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	Status ScheduledJobStatus `json:"status,omitempty"`
}

ScheduledJob represents the configuration of a single scheduled job.

func (*ScheduledJob) CodecDecodeSelf 

func (x *ScheduledJob) CodecDecodeSelf(d *codec1978.Decoder)

func (*ScheduledJob) CodecEncodeSelf 

func (x *ScheduledJob) CodecEncodeSelf(e *codec1978.Encoder)

func (*ScheduledJob) GetObjectKind 

func (obj *ScheduledJob) GetObjectKind() unversioned.ObjectKind

type ScheduledJobList 

type ScheduledJobList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	unversioned.ListMeta `json:"metadata,omitempty"`

	// Items is the list of ScheduledJob.
	Items []ScheduledJob `json:"items"`
}

ScheduledJobList is a collection of scheduled jobs.

func (*ScheduledJobList) CodecDecodeSelf 

func (x *ScheduledJobList) CodecDecodeSelf(d *codec1978.Decoder)

func (*ScheduledJobList) CodecEncodeSelf 

func (x *ScheduledJobList) CodecEncodeSelf(e *codec1978.Encoder)

func (*ScheduledJobList) GetObjectKind 

func (obj *ScheduledJobList) GetObjectKind() unversioned.ObjectKind

type ScheduledJobSpec 

type ScheduledJobSpec struct {

	// Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	Schedule string `json:"schedule"`

	// 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.
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
	ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty"`

	// Suspend flag tells the controller to suspend subsequent executions, it does
	// not apply to already started executions.  Defaults to false.
	Suspend bool `json:"suspend"`

	// JobTemplate is the object that describes the job that will be created when
	// executing a ScheduledJob.
	JobTemplate JobTemplateSpec `json:"jobTemplate"`
}

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

func (*ScheduledJobSpec) CodecDecodeSelf 

func (x *ScheduledJobSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*ScheduledJobSpec) CodecEncodeSelf 

func (x *ScheduledJobSpec) CodecEncodeSelf(e *codec1978.Encoder)

type ScheduledJobStatus 

type ScheduledJobStatus struct {
	// Active holds pointers to currently running jobs.
	Active []api.ObjectReference `json:"active,omitempty"`

	// LastScheduleTime keeps information of when was the last time the job was successfully scheduled.
	LastScheduleTime *unversioned.Time `json:"lastScheduleTime,omitempty"`
}

ScheduledJobStatus represents the current state of a Job.

func (*ScheduledJobStatus) CodecDecodeSelf 

func (x *ScheduledJobStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*ScheduledJobStatus) CodecEncodeSelf 

func (x *ScheduledJobStatus) CodecEncodeSelf(e *codec1978.Encoder)

Source Files

View all Source files

Directories

Path Synopsis
Package install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery.
 Package install installs the batch API group, making it available as an option to all of the API encoding/decoding machinery.
+genconversion=true Package v1 is a generated protocol buffer package.
 +genconversion=true Package v1 is a generated protocol buffer package.
+genconversion=true Package v2alpha1 is a generated protocol buffer package.
 +genconversion=true Package v2alpha1 is a generated protocol buffer package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.