GroupName is the group name use in this package
const GroupName = "batch"
var (
ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow")
ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
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
)
SchemeGroupVersion is group version used to register these objects
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
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.
type ConcurrencyPolicy string
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"
)
CronJob represents the configuration of a single cron job.
type CronJob 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 cron job, including the schedule.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional
Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Current status of a cron job.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional
Status CronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
func (in *CronJob) APILifecycleDeprecated() (major, minor int)
APILifecycleDeprecated is an autogenerated function, returning the release in which the API struct was or will be deprecated as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:deprecated" tags in types.go or "k8s:prerelease-lifecycle-gen:introduced" plus three minor.
func (in *CronJob) APILifecycleIntroduced() (major, minor int)
APILifecycleIntroduced is an autogenerated function, returning the release in which the API struct was introduced as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:introduced" tags in types.go.
func (in *CronJob) APILifecycleRemoved() (major, minor int)
APILifecycleRemoved is an autogenerated function, returning the release in which the API is no longer served as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:removed" tags in types.go or "k8s:prerelease-lifecycle-gen:deprecated" plus three minor.
func (in *CronJob) APILifecycleReplacement() schema.GroupVersionKind
APILifecycleReplacement is an autogenerated function, returning the group, version, and kind that should be used instead of this deprecated type. It is controlled by "k8s:prerelease-lifecycle-gen:replacement=<group>,<version>,<kind>" tags in types.go.
func (in *CronJob) DeepCopy() *CronJob
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJob.
func (in *CronJob) DeepCopyInto(out *CronJob)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *CronJob) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*CronJob) Descriptor() ([]byte, []int)
func (m *CronJob) Marshal() (dAtA []byte, err error)
func (m *CronJob) MarshalTo(dAtA []byte) (int, error)
func (m *CronJob) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*CronJob) ProtoMessage()
func (m *CronJob) Reset()
func (m *CronJob) Size() (n int)
func (this *CronJob) String() string
func (CronJob) SwaggerDoc() map[string]string
func (m *CronJob) Unmarshal(dAtA []byte) error
func (m *CronJob) XXX_DiscardUnknown()
func (m *CronJob) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *CronJob) XXX_Merge(src proto.Message)
func (m *CronJob) XXX_Size() int
func (m *CronJob) XXX_Unmarshal(b []byte) error
CronJobList is a collection of cron jobs.
type CronJobList 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 CronJobs.
Items []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
}
func (in *CronJobList) APILifecycleDeprecated() (major, minor int)
APILifecycleDeprecated is an autogenerated function, returning the release in which the API struct was or will be deprecated as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:deprecated" tags in types.go or "k8s:prerelease-lifecycle-gen:introduced" plus three minor.
func (in *CronJobList) APILifecycleIntroduced() (major, minor int)
APILifecycleIntroduced is an autogenerated function, returning the release in which the API struct was introduced as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:introduced" tags in types.go.
func (in *CronJobList) APILifecycleRemoved() (major, minor int)
APILifecycleRemoved is an autogenerated function, returning the release in which the API is no longer served as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:removed" tags in types.go or "k8s:prerelease-lifecycle-gen:deprecated" plus three minor.
func (in *CronJobList) APILifecycleReplacement() schema.GroupVersionKind
APILifecycleReplacement is an autogenerated function, returning the group, version, and kind that should be used instead of this deprecated type. It is controlled by "k8s:prerelease-lifecycle-gen:replacement=<group>,<version>,<kind>" tags in types.go.
func (in *CronJobList) DeepCopy() *CronJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobList.
func (in *CronJobList) DeepCopyInto(out *CronJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *CronJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*CronJobList) Descriptor() ([]byte, []int)
func (m *CronJobList) Marshal() (dAtA []byte, err error)
func (m *CronJobList) MarshalTo(dAtA []byte) (int, error)
func (m *CronJobList) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*CronJobList) ProtoMessage()
func (m *CronJobList) Reset()
func (m *CronJobList) Size() (n int)
func (this *CronJobList) String() string
func (CronJobList) SwaggerDoc() map[string]string
func (m *CronJobList) Unmarshal(dAtA []byte) error
func (m *CronJobList) XXX_DiscardUnknown()
func (m *CronJobList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *CronJobList) XXX_Merge(src proto.Message)
func (m *CronJobList) XXX_Size() int
func (m *CronJobList) XXX_Unmarshal(b []byte) error
CronJobSpec describes how the job execution will look like and when it will actually run.
type CronJobSpec struct {
// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string `json:"schedule" protobuf:"bytes,1,opt,name=schedule"`
// The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
// If not specified, this will default to the time zone of the kube-controller-manager process.
// The set of valid time zone names and the time zone offset is loaded from the system-wide time zone
// database by the API server during CronJob validation and the controller manager during execution.
// If no system-wide time zone database can be found a bundled version of the database is used instead.
// If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host
// configuration, the controller will stop creating new new Jobs and will create a system event with the
// reason UnknownTimeZone.
// More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
// +optional
TimeZone *string `json:"timeZone,omitempty" protobuf:"bytes,8,opt,name=timeZone"`
// 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 `json:"startingDeadlineSeconds,omitempty" protobuf:"varint,2,opt,name=startingDeadlineSeconds"`
// 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 `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`
// This flag tells the controller to suspend subsequent executions, it does
// not apply to already started executions. Defaults to false.
// +optional
Suspend *bool `json:"suspend,omitempty" protobuf:"varint,4,opt,name=suspend"`
// Specifies the job that will be created when executing a CronJob.
JobTemplate JobTemplateSpec `json:"jobTemplate" protobuf:"bytes,5,opt,name=jobTemplate"`
// The number of successful finished jobs to retain.
// This is a pointer to distinguish between explicit zero and not specified.
// Defaults to 3.
// +optional
SuccessfulJobsHistoryLimit *int32 `json:"successfulJobsHistoryLimit,omitempty" protobuf:"varint,6,opt,name=successfulJobsHistoryLimit"`
// The number of failed finished jobs to retain.
// This is a pointer to distinguish between explicit zero and not specified.
// Defaults to 1.
// +optional
FailedJobsHistoryLimit *int32 `json:"failedJobsHistoryLimit,omitempty" protobuf:"varint,7,opt,name=failedJobsHistoryLimit"`
}
func (in *CronJobSpec) DeepCopy() *CronJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobSpec.
func (in *CronJobSpec) DeepCopyInto(out *CronJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CronJobSpec) Descriptor() ([]byte, []int)
func (m *CronJobSpec) Marshal() (dAtA []byte, err error)
func (m *CronJobSpec) MarshalTo(dAtA []byte) (int, error)
func (m *CronJobSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*CronJobSpec) ProtoMessage()
func (m *CronJobSpec) Reset()
func (m *CronJobSpec) Size() (n int)
func (this *CronJobSpec) String() string
func (CronJobSpec) SwaggerDoc() map[string]string
func (m *CronJobSpec) Unmarshal(dAtA []byte) error
func (m *CronJobSpec) XXX_DiscardUnknown()
func (m *CronJobSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *CronJobSpec) XXX_Merge(src proto.Message)
func (m *CronJobSpec) XXX_Size() int
func (m *CronJobSpec) XXX_Unmarshal(b []byte) error
CronJobStatus represents the current state of a cron job.
type CronJobStatus struct {
// A list of pointers to currently running jobs.
// +optional
// +listType=atomic
Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"`
// Information when was the last time the job was successfully scheduled.
// +optional
LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty" protobuf:"bytes,4,opt,name=lastScheduleTime"`
// Information when was the last time the job successfully completed.
// +optional
LastSuccessfulTime *metav1.Time `json:"lastSuccessfulTime,omitempty" protobuf:"bytes,5,opt,name=lastSuccessfulTime"`
}
func (in *CronJobStatus) DeepCopy() *CronJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CronJobStatus.
func (in *CronJobStatus) DeepCopyInto(out *CronJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CronJobStatus) Descriptor() ([]byte, []int)
func (m *CronJobStatus) Marshal() (dAtA []byte, err error)
func (m *CronJobStatus) MarshalTo(dAtA []byte) (int, error)
func (m *CronJobStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*CronJobStatus) ProtoMessage()
func (m *CronJobStatus) Reset()
func (m *CronJobStatus) Size() (n int)
func (this *CronJobStatus) String() string
func (CronJobStatus) SwaggerDoc() map[string]string
func (m *CronJobStatus) Unmarshal(dAtA []byte) error
func (m *CronJobStatus) XXX_DiscardUnknown()
func (m *CronJobStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *CronJobStatus) XXX_Merge(src proto.Message)
func (m *CronJobStatus) XXX_Size() int
func (m *CronJobStatus) XXX_Unmarshal(b []byte) error
JobTemplateSpec describes the data a Job should have when created from a template
type JobTemplateSpec struct {
// Standard object's metadata of the jobs created from this template.
// 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 the job.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional
Spec batchv1.JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobTemplateSpec.
func (in *JobTemplateSpec) DeepCopyInto(out *JobTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*JobTemplateSpec) Descriptor() ([]byte, []int)
func (m *JobTemplateSpec) Marshal() (dAtA []byte, err error)
func (m *JobTemplateSpec) MarshalTo(dAtA []byte) (int, error)
func (m *JobTemplateSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*JobTemplateSpec) ProtoMessage()
func (m *JobTemplateSpec) Reset()
func (m *JobTemplateSpec) Size() (n int)
func (this *JobTemplateSpec) String() string
func (JobTemplateSpec) SwaggerDoc() map[string]string
func (m *JobTemplateSpec) Unmarshal(dAtA []byte) error
func (m *JobTemplateSpec) XXX_DiscardUnknown()
func (m *JobTemplateSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *JobTemplateSpec) XXX_Merge(src proto.Message)
func (m *JobTemplateSpec) XXX_Size() int
func (m *JobTemplateSpec) XXX_Unmarshal(b []byte) error