batch

Documentation

Index

• Constants
• Variables
• func AddToScheme(scheme *runtime.Scheme)
• func DeepCopy_batch_Job(in Job, out *Job, c *conversion.Cloner) error
• func DeepCopy_batch_JobCondition(in JobCondition, out *JobCondition, c *conversion.Cloner) error
• func DeepCopy_batch_JobList(in JobList, out *JobList, c *conversion.Cloner) error
• func DeepCopy_batch_JobSpec(in JobSpec, out *JobSpec, c *conversion.Cloner) error
• func DeepCopy_batch_JobStatus(in JobStatus, out *JobStatus, c *conversion.Cloner) error
• func Kind(kind string) unversioned.GroupKind
• func Resource(resource string) unversioned.GroupResource
• type Job
  • func (x *Job) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *Job) CodecEncodeSelf(e *codec1978.Encoder)
  • func (obj *Job) GetObjectKind() unversioned.ObjectKind
• type JobCondition
  • func (x *JobCondition) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *JobCondition) CodecEncodeSelf(e *codec1978.Encoder)
• type JobConditionType
  • func (x *JobConditionType) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x JobConditionType) CodecEncodeSelf(e *codec1978.Encoder)
• type JobList
  • func (x *JobList) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *JobList) CodecEncodeSelf(e *codec1978.Encoder)
  • func (obj *JobList) GetObjectKind() unversioned.ObjectKind
• type JobSpec
  • func (x *JobSpec) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *JobSpec) CodecEncodeSelf(e *codec1978.Encoder)
• type JobStatus
  • func (x *JobStatus) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *JobStatus) CodecEncodeSelf(e *codec1978.Encoder)

Constants

const GroupName = "batch"

GroupName is the group name use in this package

Variables

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