v1beta1

package
v0.0.0-...-d88c8b5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 9, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

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: "v1beta1"}

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 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 `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"`
}

CronJob represents the configuration of a single cron job.

func (*CronJob) APILifecycleDeprecated

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 (*CronJob) APILifecycleIntroduced

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 (*CronJob) APILifecycleRemoved

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 (*CronJob) DeepCopy

func (in *CronJob) DeepCopy() *CronJob

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

func (*CronJob) DeepCopyInto

func (in *CronJob) DeepCopyInto(out *CronJob)

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

func (*CronJob) DeepCopyObject

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

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

func (*CronJob) Descriptor

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

func (*CronJob) Marshal

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

func (*CronJob) MarshalTo

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

func (*CronJob) MarshalToSizedBuffer

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

func (*CronJob) ProtoMessage

func (*CronJob) ProtoMessage()

func (*CronJob) Reset

func (m *CronJob) Reset()

func (*CronJob) Size

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

func (*CronJob) String

func (this *CronJob) String() string

func (CronJob) SwaggerDoc

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

func (*CronJob) Unmarshal

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

func (*CronJob) XXX_DiscardUnknown

func (m *CronJob) XXX_DiscardUnknown()

func (*CronJob) XXX_Marshal

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

func (*CronJob) XXX_Merge

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

func (*CronJob) XXX_Size

func (m *CronJob) XXX_Size() int

func (*CronJob) XXX_Unmarshal

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

type CronJobList

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"`
}

CronJobList is a collection of cron jobs.

func (*CronJobList) APILifecycleDeprecated

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 (*CronJobList) APILifecycleIntroduced

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 (*CronJobList) APILifecycleRemoved

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 (*CronJobList) DeepCopy

func (in *CronJobList) DeepCopy() *CronJobList

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

func (*CronJobList) DeepCopyInto

func (in *CronJobList) DeepCopyInto(out *CronJobList)

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

func (*CronJobList) DeepCopyObject

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

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

func (*CronJobList) Descriptor

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

func (*CronJobList) Marshal

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

func (*CronJobList) MarshalTo

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

func (*CronJobList) MarshalToSizedBuffer

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

func (*CronJobList) ProtoMessage

func (*CronJobList) ProtoMessage()

func (*CronJobList) Reset

func (m *CronJobList) Reset()

func (*CronJobList) Size

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

func (*CronJobList) String

func (this *CronJobList) String() string

func (CronJobList) SwaggerDoc

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

func (*CronJobList) Unmarshal

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

func (*CronJobList) XXX_DiscardUnknown

func (m *CronJobList) XXX_DiscardUnknown()

func (*CronJobList) XXX_Marshal

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

func (*CronJobList) XXX_Merge

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

func (*CronJobList) XXX_Size

func (m *CronJobList) XXX_Size() int

func (*CronJobList) XXX_Unmarshal

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

type CronJobSpec

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"`

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

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

func (*CronJobSpec) DeepCopy

func (in *CronJobSpec) DeepCopy() *CronJobSpec

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

func (*CronJobSpec) DeepCopyInto

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

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

func (*CronJobSpec) Marshal

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

func (*CronJobSpec) MarshalTo

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

func (*CronJobSpec) MarshalToSizedBuffer

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

func (*CronJobSpec) ProtoMessage

func (*CronJobSpec) ProtoMessage()

func (*CronJobSpec) Reset

func (m *CronJobSpec) Reset()

func (*CronJobSpec) Size

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

func (*CronJobSpec) String

func (this *CronJobSpec) String() string

func (CronJobSpec) SwaggerDoc

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

func (*CronJobSpec) Unmarshal

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

func (*CronJobSpec) XXX_DiscardUnknown

func (m *CronJobSpec) XXX_DiscardUnknown()

func (*CronJobSpec) XXX_Marshal

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

func (*CronJobSpec) XXX_Merge

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

func (*CronJobSpec) XXX_Size

func (m *CronJobSpec) XXX_Size() int

func (*CronJobSpec) XXX_Unmarshal

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

type CronJobStatus

type CronJobStatus 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"`
}

CronJobStatus represents the current state of a cron job.

func (*CronJobStatus) DeepCopy

func (in *CronJobStatus) DeepCopy() *CronJobStatus

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

func (*CronJobStatus) DeepCopyInto

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

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

func (*CronJobStatus) Marshal

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

func (*CronJobStatus) MarshalTo

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

func (*CronJobStatus) MarshalToSizedBuffer

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

func (*CronJobStatus) ProtoMessage

func (*CronJobStatus) ProtoMessage()

func (*CronJobStatus) Reset

func (m *CronJobStatus) Reset()

func (*CronJobStatus) Size

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

func (*CronJobStatus) String

func (this *CronJobStatus) String() string

func (CronJobStatus) SwaggerDoc

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

func (*CronJobStatus) Unmarshal

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

func (*CronJobStatus) XXX_DiscardUnknown

func (m *CronJobStatus) XXX_DiscardUnknown()

func (*CronJobStatus) XXX_Marshal

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

func (*CronJobStatus) XXX_Merge

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

func (*CronJobStatus) XXX_Size

func (m *CronJobStatus) XXX_Size() int

func (*CronJobStatus) XXX_Unmarshal

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

type JobTemplate

type JobTemplate 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"`

	// Defines jobs that will be created from this template.
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Template JobTemplateSpec `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"`
}

JobTemplate describes a template for creating copies of a predefined pod.

func (*JobTemplate) APILifecycleDeprecated

func (in *JobTemplate) 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 (*JobTemplate) APILifecycleIntroduced

func (in *JobTemplate) 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 (*JobTemplate) APILifecycleRemoved

func (in *JobTemplate) 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 (*JobTemplate) DeepCopy

func (in *JobTemplate) DeepCopy() *JobTemplate

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

func (*JobTemplate) DeepCopyInto

func (in *JobTemplate) DeepCopyInto(out *JobTemplate)

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

func (*JobTemplate) DeepCopyObject

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

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

func (*JobTemplate) Descriptor

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

func (*JobTemplate) Marshal

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

func (*JobTemplate) MarshalTo

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

func (*JobTemplate) MarshalToSizedBuffer

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

func (*JobTemplate) ProtoMessage

func (*JobTemplate) ProtoMessage()

func (*JobTemplate) Reset

func (m *JobTemplate) Reset()

func (*JobTemplate) Size

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

func (*JobTemplate) String

func (this *JobTemplate) String() string

func (JobTemplate) SwaggerDoc

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

func (*JobTemplate) Unmarshal

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

func (*JobTemplate) XXX_DiscardUnknown

func (m *JobTemplate) XXX_DiscardUnknown()

func (*JobTemplate) XXX_Marshal

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

func (*JobTemplate) XXX_Merge

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

func (*JobTemplate) XXX_Size

func (m *JobTemplate) XXX_Size() int

func (*JobTemplate) XXX_Unmarshal

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

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

JobTemplateSpec describes the data a Job should have when created from a template

func (*JobTemplateSpec) DeepCopy

func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec

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

func (*JobTemplateSpec) DeepCopyInto

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

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

func (*JobTemplateSpec) Marshal

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

func (*JobTemplateSpec) MarshalTo

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

func (*JobTemplateSpec) MarshalToSizedBuffer

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

func (*JobTemplateSpec) ProtoMessage

func (*JobTemplateSpec) ProtoMessage()

func (*JobTemplateSpec) Reset

func (m *JobTemplateSpec) Reset()

func (*JobTemplateSpec) Size

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

func (*JobTemplateSpec) String

func (this *JobTemplateSpec) String() string

func (JobTemplateSpec) SwaggerDoc

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

func (*JobTemplateSpec) Unmarshal

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

func (*JobTemplateSpec) XXX_DiscardUnknown

func (m *JobTemplateSpec) XXX_DiscardUnknown()

func (*JobTemplateSpec) XXX_Marshal

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

func (*JobTemplateSpec) XXX_Merge

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

func (*JobTemplateSpec) XXX_Size

func (m *JobTemplateSpec) XXX_Size() int

func (*JobTemplateSpec) XXX_Unmarshal

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL