Documentation

Index

Constants

View Source
const GroupName = "batch"

    GroupName is the group name use in this package

    Variables

    View Source
    var (
    	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
    	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
    )
    View Source
    var (
    	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
    	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
    	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    
    	AddToScheme = localSchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

      SchemeGroupVersion is group version used to register these objects

      Functions

      func Resource

      func Resource(resource string) schema.GroupResource

        Resource takes an unqualified resource and returns a Group qualified GroupResource

        Types

        type Job

        type Job struct {
        	metav1.TypeMeta `json:",inline"`
        	// Standard object's metadata.
        	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
        	// +optional
        	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
        
        	// Specification of the desired behavior of a job.
        	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
        	// +optional
        	Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
        
        	// Current status of a job.
        	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
        	// +optional
        	Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
        }

          Job represents the configuration of a single job.

          func (*Job) DeepCopy

          func (in *Job) DeepCopy() *Job

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

            func (*Job) DeepCopyInto

            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

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

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

                func (*Job) Descriptor

                func (*Job) Descriptor() ([]byte, []int)

                func (*Job) Marshal

                func (m *Job) Marshal() (dAtA []byte, err error)

                func (*Job) MarshalTo

                func (m *Job) MarshalTo(dAtA []byte) (int, error)

                func (*Job) MarshalToSizedBuffer

                func (m *Job) MarshalToSizedBuffer(dAtA []byte) (int, error)

                func (*Job) ProtoMessage

                func (*Job) ProtoMessage()

                func (*Job) Reset

                func (m *Job) Reset()

                func (*Job) Size

                func (m *Job) Size() (n int)

                func (*Job) String

                func (this *Job) String() string

                func (Job) SwaggerDoc

                func (Job) SwaggerDoc() map[string]string

                func (*Job) Unmarshal

                func (m *Job) Unmarshal(dAtA []byte) error

                func (*Job) XXX_DiscardUnknown

                func (m *Job) XXX_DiscardUnknown()

                func (*Job) XXX_Marshal

                func (m *Job) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                func (*Job) XXX_Merge

                func (m *Job) XXX_Merge(src proto.Message)

                func (*Job) XXX_Size

                func (m *Job) XXX_Size() int

                func (*Job) XXX_Unmarshal

                func (m *Job) XXX_Unmarshal(b []byte) error

                type JobCondition

                type JobCondition struct {
                	// Type of job condition, Complete or Failed.
                	Type JobConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=JobConditionType"`
                	// Status of the condition, one of True, False, Unknown.
                	Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
                	// Last time the condition was checked.
                	// +optional
                	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty" protobuf:"bytes,3,opt,name=lastProbeTime"`
                	// Last time the condition transit from one status to another.
                	// +optional
                	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,4,opt,name=lastTransitionTime"`
                	// (brief) reason for the condition's last transition.
                	// +optional
                	Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`
                	// Human readable message indicating details about last transition.
                	// +optional
                	Message string `json:"message,omitempty" protobuf:"bytes,6,opt,name=message"`
                }

                  JobCondition describes current state of a job.

                  func (*JobCondition) DeepCopy

                  func (in *JobCondition) DeepCopy() *JobCondition

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

                    func (*JobCondition) DeepCopyInto

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

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

                      func (*JobCondition) Descriptor

                      func (*JobCondition) Descriptor() ([]byte, []int)

                      func (*JobCondition) Marshal

                      func (m *JobCondition) Marshal() (dAtA []byte, err error)

                      func (*JobCondition) MarshalTo

                      func (m *JobCondition) MarshalTo(dAtA []byte) (int, error)

                      func (*JobCondition) MarshalToSizedBuffer

                      func (m *JobCondition) MarshalToSizedBuffer(dAtA []byte) (int, error)

                      func (*JobCondition) ProtoMessage

                      func (*JobCondition) ProtoMessage()

                      func (*JobCondition) Reset

                      func (m *JobCondition) Reset()

                      func (*JobCondition) Size

                      func (m *JobCondition) Size() (n int)

                      func (*JobCondition) String

                      func (this *JobCondition) String() string

                      func (JobCondition) SwaggerDoc

                      func (JobCondition) SwaggerDoc() map[string]string

                      func (*JobCondition) Unmarshal

                      func (m *JobCondition) Unmarshal(dAtA []byte) error

                      func (*JobCondition) XXX_DiscardUnknown

                      func (m *JobCondition) XXX_DiscardUnknown()

                      func (*JobCondition) XXX_Marshal

                      func (m *JobCondition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                      func (*JobCondition) XXX_Merge

                      func (m *JobCondition) XXX_Merge(src proto.Message)

                      func (*JobCondition) XXX_Size

                      func (m *JobCondition) XXX_Size() int

                      func (*JobCondition) XXX_Unmarshal

                      func (m *JobCondition) XXX_Unmarshal(b []byte) error

                      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 `json:",inline"`
                        	// Standard list metadata.
                        	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
                        	// +optional
                        	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                        
                        	// items is the list of Jobs.
                        	Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"`
                        }

                          JobList is a collection of jobs.

                          func (*JobList) DeepCopy

                          func (in *JobList) DeepCopy() *JobList

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

                            func (*JobList) DeepCopyInto

                            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

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

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

                                func (*JobList) Descriptor

                                func (*JobList) Descriptor() ([]byte, []int)

                                func (*JobList) Marshal

                                func (m *JobList) Marshal() (dAtA []byte, err error)

                                func (*JobList) MarshalTo

                                func (m *JobList) MarshalTo(dAtA []byte) (int, error)

                                func (*JobList) MarshalToSizedBuffer

                                func (m *JobList) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                func (*JobList) ProtoMessage

                                func (*JobList) ProtoMessage()

                                func (*JobList) Reset

                                func (m *JobList) Reset()

                                func (*JobList) Size

                                func (m *JobList) Size() (n int)

                                func (*JobList) String

                                func (this *JobList) String() string

                                func (JobList) SwaggerDoc

                                func (JobList) SwaggerDoc() map[string]string

                                func (*JobList) Unmarshal

                                func (m *JobList) Unmarshal(dAtA []byte) error

                                func (*JobList) XXX_DiscardUnknown

                                func (m *JobList) XXX_DiscardUnknown()

                                func (*JobList) XXX_Marshal

                                func (m *JobList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                func (*JobList) XXX_Merge

                                func (m *JobList) XXX_Merge(src proto.Message)

                                func (*JobList) XXX_Size

                                func (m *JobList) XXX_Size() int

                                func (*JobList) XXX_Unmarshal

                                func (m *JobList) XXX_Unmarshal(b []byte) error

                                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.
                                	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
                                	// +optional
                                	Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"`
                                
                                	// 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/
                                	// +optional
                                	Completions *int32 `json:"completions,omitempty" protobuf:"varint,2,opt,name=completions"`
                                
                                	// 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
                                	// +optional
                                	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"`
                                
                                	// Specifies the number of retries before marking this job failed.
                                	// Defaults to 6
                                	// +optional
                                	BackoffLimit *int32 `json:"backoffLimit,omitempty" protobuf:"varint,7,opt,name=backoffLimit"`
                                
                                	// 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
                                	// +optional
                                	Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"`
                                
                                	// 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
                                	// +optional
                                	ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"`
                                
                                	// Describes the pod that will be created when executing a job.
                                	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
                                	Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"`
                                
                                	// 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 `json:"ttlSecondsAfterFinished,omitempty" protobuf:"varint,8,opt,name=ttlSecondsAfterFinished"`
                                }

                                  JobSpec describes how the job execution will look like.

                                  func (*JobSpec) DeepCopy

                                  func (in *JobSpec) DeepCopy() *JobSpec

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

                                    func (*JobSpec) DeepCopyInto

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

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

                                      func (*JobSpec) Descriptor

                                      func (*JobSpec) Descriptor() ([]byte, []int)

                                      func (*JobSpec) Marshal

                                      func (m *JobSpec) Marshal() (dAtA []byte, err error)

                                      func (*JobSpec) MarshalTo

                                      func (m *JobSpec) MarshalTo(dAtA []byte) (int, error)

                                      func (*JobSpec) MarshalToSizedBuffer

                                      func (m *JobSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                      func (*JobSpec) ProtoMessage

                                      func (*JobSpec) ProtoMessage()

                                      func (*JobSpec) Reset

                                      func (m *JobSpec) Reset()

                                      func (*JobSpec) Size

                                      func (m *JobSpec) Size() (n int)

                                      func (*JobSpec) String

                                      func (this *JobSpec) String() string

                                      func (JobSpec) SwaggerDoc

                                      func (JobSpec) SwaggerDoc() map[string]string

                                      func (*JobSpec) Unmarshal

                                      func (m *JobSpec) Unmarshal(dAtA []byte) error

                                      func (*JobSpec) XXX_DiscardUnknown

                                      func (m *JobSpec) XXX_DiscardUnknown()

                                      func (*JobSpec) XXX_Marshal

                                      func (m *JobSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                      func (*JobSpec) XXX_Merge

                                      func (m *JobSpec) XXX_Merge(src proto.Message)

                                      func (*JobSpec) XXX_Size

                                      func (m *JobSpec) XXX_Size() int

                                      func (*JobSpec) XXX_Unmarshal

                                      func (m *JobSpec) XXX_Unmarshal(b []byte) error

                                      type JobStatus

                                      type JobStatus struct {
                                      	// The latest available observations of an object's current state.
                                      	// When a job fails, one of the conditions will have type == "Failed".
                                      	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
                                      	// +optional
                                      	// +patchMergeKey=type
                                      	// +patchStrategy=merge
                                      	Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
                                      
                                      	// 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 `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"`
                                      
                                      	// 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.
                                      	// The completion time is only set when the job finishes successfully.
                                      	// +optional
                                      	CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"`
                                      
                                      	// The number of actively running pods.
                                      	// +optional
                                      	Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"`
                                      
                                      	// The number of pods which reached phase Succeeded.
                                      	// +optional
                                      	Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"`
                                      
                                      	// The number of pods which reached phase Failed.
                                      	// +optional
                                      	Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"`
                                      }

                                        JobStatus represents the current state of a Job.

                                        func (*JobStatus) DeepCopy

                                        func (in *JobStatus) DeepCopy() *JobStatus

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

                                          func (*JobStatus) DeepCopyInto

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

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

                                            func (*JobStatus) Descriptor

                                            func (*JobStatus) Descriptor() ([]byte, []int)

                                            func (*JobStatus) Marshal

                                            func (m *JobStatus) Marshal() (dAtA []byte, err error)

                                            func (*JobStatus) MarshalTo

                                            func (m *JobStatus) MarshalTo(dAtA []byte) (int, error)

                                            func (*JobStatus) MarshalToSizedBuffer

                                            func (m *JobStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                            func (*JobStatus) ProtoMessage

                                            func (*JobStatus) ProtoMessage()

                                            func (*JobStatus) Reset

                                            func (m *JobStatus) Reset()

                                            func (*JobStatus) Size

                                            func (m *JobStatus) Size() (n int)

                                            func (*JobStatus) String

                                            func (this *JobStatus) String() string

                                            func (JobStatus) SwaggerDoc

                                            func (JobStatus) SwaggerDoc() map[string]string

                                            func (*JobStatus) Unmarshal

                                            func (m *JobStatus) Unmarshal(dAtA []byte) error

                                            func (*JobStatus) XXX_DiscardUnknown

                                            func (m *JobStatus) XXX_DiscardUnknown()

                                            func (*JobStatus) XXX_Marshal

                                            func (m *JobStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                            func (*JobStatus) XXX_Merge

                                            func (m *JobStatus) XXX_Merge(src proto.Message)

                                            func (*JobStatus) XXX_Size

                                            func (m *JobStatus) XXX_Size() int

                                            func (*JobStatus) XXX_Unmarshal

                                            func (m *JobStatus) XXX_Unmarshal(b []byte) error