v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 of the API. +groupName=cronjobber.hidde.co

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ConcurrencyPolicy
• type TZCronJob
  • func (in *TZCronJob) DeepCopy() *TZCronJob
  • func (in *TZCronJob) DeepCopyInto(out *TZCronJob)
  • func (in *TZCronJob) DeepCopyObject() runtime.Object
• type TZCronJobList
  • func (in *TZCronJobList) DeepCopy() *TZCronJobList
  • func (in *TZCronJobList) DeepCopyInto(out *TZCronJobList)
  • func (in *TZCronJobList) DeepCopyObject() runtime.Object
• type TZCronJobSpec
  • func (in *TZCronJobSpec) DeepCopy() *TZCronJobSpec
  • func (in *TZCronJobSpec) DeepCopyInto(out *TZCronJobSpec)
• type TZCronJobStatus
  • func (in *TZCronJobStatus) DeepCopy() *TZCronJobStatus
  • func (in *TZCronJobStatus) DeepCopyInto(out *TZCronJobStatus)

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: api.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

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 TZCronJob

type TZCronJob struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
	// +optional
	Spec TZCronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Current status of a cron job.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Status TZCronJobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

TZCronJob represents the configuration of a single cron job.

func (*TZCronJob) DeepCopy

func (in *TZCronJob) DeepCopy() *TZCronJob

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

func (*TZCronJob) DeepCopyInto

func (in *TZCronJob) DeepCopyInto(out *TZCronJob)

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

func (*TZCronJob) DeepCopyObject

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

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

type TZCronJobList

type TZCronJobList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// items is the list of CronJobs.
	Items []TZCronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
}

TZCronJobList is a collection of cron jobs.

func (*TZCronJobList) DeepCopy

func (in *TZCronJobList) DeepCopy() *TZCronJobList

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

func (*TZCronJobList) DeepCopyInto

func (in *TZCronJobList) DeepCopyInto(out *TZCronJobList)

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

func (*TZCronJobList) DeepCopyObject

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

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

type TZCronJobSpec

type TZCronJobSpec 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 to be used when scheduling the job given the schedule specified above.
	// Valid options include anything in the IANA Time Zone database.
	// +optional
	TimeZone string `json:"timezone" 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 TZCronJob.
	JobTemplate batchv1beta1.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"`
}

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

func (*TZCronJobSpec) DeepCopy

func (in *TZCronJobSpec) DeepCopy() *TZCronJobSpec

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

func (*TZCronJobSpec) DeepCopyInto

func (in *TZCronJobSpec) DeepCopyInto(out *TZCronJobSpec)

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

type TZCronJobStatus

type TZCronJobStatus struct {
	// A list of pointers to currently running jobs.
	// +optional
	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"`
}

TZCronJobStatus represents the current state of a cron job.

func (*TZCronJobStatus) DeepCopy

func (in *TZCronJobStatus) DeepCopy() *TZCronJobStatus

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

func (*TZCronJobStatus) DeepCopyInto

func (in *TZCronJobStatus) DeepCopyInto(out *TZCronJobStatus)

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