Documentation

Index

Constants

View Source
const GroupName = "batch"

    GroupName is the group name use in this package

    Variables

    View Source
    var (
    	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    	AddToScheme   = SchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

      SchemeGroupVersion is group version used to register these objects

      Functions

      func DeepCopy_batch_CronJob

      func DeepCopy_batch_CronJob(in interface{}, out interface{}, c *conversion.Cloner) error

        DeepCopy_batch_CronJob is an autogenerated deepcopy function.

        func DeepCopy_batch_CronJobList

        func DeepCopy_batch_CronJobList(in interface{}, out interface{}, c *conversion.Cloner) error

          DeepCopy_batch_CronJobList is an autogenerated deepcopy function.

          func DeepCopy_batch_CronJobSpec

          func DeepCopy_batch_CronJobSpec(in interface{}, out interface{}, c *conversion.Cloner) error

            DeepCopy_batch_CronJobSpec is an autogenerated deepcopy function.

            func DeepCopy_batch_CronJobStatus

            func DeepCopy_batch_CronJobStatus(in interface{}, out interface{}, c *conversion.Cloner) error

              DeepCopy_batch_CronJobStatus is an autogenerated deepcopy function.

              func DeepCopy_batch_Job

              func DeepCopy_batch_Job(in interface{}, out interface{}, c *conversion.Cloner) error

                DeepCopy_batch_Job is an autogenerated deepcopy function.

                func DeepCopy_batch_JobCondition

                func DeepCopy_batch_JobCondition(in interface{}, out interface{}, c *conversion.Cloner) error

                  DeepCopy_batch_JobCondition is an autogenerated deepcopy function.

                  func DeepCopy_batch_JobList

                  func DeepCopy_batch_JobList(in interface{}, out interface{}, c *conversion.Cloner) error

                    DeepCopy_batch_JobList is an autogenerated deepcopy function.

                    func DeepCopy_batch_JobSpec

                    func DeepCopy_batch_JobSpec(in interface{}, out interface{}, c *conversion.Cloner) error

                      DeepCopy_batch_JobSpec is an autogenerated deepcopy function.

                      func DeepCopy_batch_JobStatus

                      func DeepCopy_batch_JobStatus(in interface{}, out interface{}, c *conversion.Cloner) error

                        DeepCopy_batch_JobStatus is an autogenerated deepcopy function.

                        func DeepCopy_batch_JobTemplate

                        func DeepCopy_batch_JobTemplate(in interface{}, out interface{}, c *conversion.Cloner) error

                          DeepCopy_batch_JobTemplate is an autogenerated deepcopy function.

                          func DeepCopy_batch_JobTemplateSpec

                          func DeepCopy_batch_JobTemplateSpec(in interface{}, out interface{}, c *conversion.Cloner) error

                            DeepCopy_batch_JobTemplateSpec is an autogenerated deepcopy function.

                            func Kind

                            func Kind(kind string) schema.GroupKind

                              Kind takes an unqualified kind and returns a Group qualified GroupKind

                              func RegisterDeepCopies

                              func RegisterDeepCopies(scheme *runtime.Scheme) error

                                RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

                                func Resource

                                func Resource(resource string) schema.GroupResource

                                  Resource takes an unqualified resource and returns 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 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

                                    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.

                                      type CronJobList

                                      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.

                                        type CronJobSpec

                                        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.
                                        	// Defaults to Allow.
                                        	// +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.

                                          type CronJobStatus

                                          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.

                                            type Job

                                            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.

                                              type JobCondition

                                              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.

                                                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.

                                                  type JobList

                                                  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.

                                                    type JobSpec

                                                    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
                                                    
                                                    	// 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
                                                    }

                                                      JobSpec describes how the job execution will look like.

                                                      type JobStatus

                                                      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.

                                                        type JobTemplate

                                                        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.

                                                          type JobTemplateSpec

                                                          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

                                                            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.
                                                            Package v1 is a generated protocol buffer package.
                                                            Package v1 is a generated protocol buffer package.
                                                            Package v2alpha1 is a generated protocol buffer package.
                                                            Package v2alpha1 is a generated protocol buffer package.