Documentation ¶
Overview ¶
Package v2alpha1 is a generated protocol buffer package.
It is generated from these files:
k8s.io/api/batch/v2alpha1/generated.proto
It has these top-level messages:
CronJob CronJobList CronJobSpec CronJobStatus JobTemplate JobTemplateSpec
Index ¶
- Variables
- type CronJob
- func (*CronJob) Descriptor() ([]byte, []int)
- func (m *CronJob) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
- func (m *CronJob) GetSpec() *CronJobSpec
- func (m *CronJob) GetStatus() *CronJobStatus
- func (m *CronJob) Marshal() (dAtA []byte, err error)
- func (m *CronJob) MarshalTo(dAtA []byte) (int, error)
- func (*CronJob) ProtoMessage()
- func (m *CronJob) Reset()
- func (m *CronJob) Size() (n int)
- func (m *CronJob) String() string
- func (m *CronJob) Unmarshal(dAtA []byte) error
- type CronJobList
- func (*CronJobList) Descriptor() ([]byte, []int)
- func (m *CronJobList) GetItems() []*CronJob
- func (m *CronJobList) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ListMeta
- func (m *CronJobList) Marshal() (dAtA []byte, err error)
- func (m *CronJobList) MarshalTo(dAtA []byte) (int, error)
- func (*CronJobList) ProtoMessage()
- func (m *CronJobList) Reset()
- func (m *CronJobList) Size() (n int)
- func (m *CronJobList) String() string
- func (m *CronJobList) Unmarshal(dAtA []byte) error
- type CronJobSpec
- func (*CronJobSpec) Descriptor() ([]byte, []int)
- func (m *CronJobSpec) GetConcurrencyPolicy() string
- func (m *CronJobSpec) GetFailedJobsHistoryLimit() int32
- func (m *CronJobSpec) GetJobTemplate() *JobTemplateSpec
- func (m *CronJobSpec) GetSchedule() string
- func (m *CronJobSpec) GetStartingDeadlineSeconds() int64
- func (m *CronJobSpec) GetSuccessfulJobsHistoryLimit() int32
- func (m *CronJobSpec) GetSuspend() bool
- func (m *CronJobSpec) Marshal() (dAtA []byte, err error)
- func (m *CronJobSpec) MarshalTo(dAtA []byte) (int, error)
- func (*CronJobSpec) ProtoMessage()
- func (m *CronJobSpec) Reset()
- func (m *CronJobSpec) Size() (n int)
- func (m *CronJobSpec) String() string
- func (m *CronJobSpec) Unmarshal(dAtA []byte) error
- type CronJobStatus
- func (*CronJobStatus) Descriptor() ([]byte, []int)
- func (m *CronJobStatus) GetActive() []*k8s_io_api_core_v1.ObjectReference
- func (m *CronJobStatus) GetLastScheduleTime() *k8s_io_apimachinery_pkg_apis_meta_v1.Time
- func (m *CronJobStatus) Marshal() (dAtA []byte, err error)
- func (m *CronJobStatus) MarshalTo(dAtA []byte) (int, error)
- func (*CronJobStatus) ProtoMessage()
- func (m *CronJobStatus) Reset()
- func (m *CronJobStatus) Size() (n int)
- func (m *CronJobStatus) String() string
- func (m *CronJobStatus) Unmarshal(dAtA []byte) error
- type JobTemplate
- func (*JobTemplate) Descriptor() ([]byte, []int)
- func (m *JobTemplate) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
- func (m *JobTemplate) GetTemplate() *JobTemplateSpec
- func (m *JobTemplate) Marshal() (dAtA []byte, err error)
- func (m *JobTemplate) MarshalTo(dAtA []byte) (int, error)
- func (*JobTemplate) ProtoMessage()
- func (m *JobTemplate) Reset()
- func (m *JobTemplate) Size() (n int)
- func (m *JobTemplate) String() string
- func (m *JobTemplate) Unmarshal(dAtA []byte) error
- type JobTemplateSpec
- func (*JobTemplateSpec) Descriptor() ([]byte, []int)
- func (m *JobTemplateSpec) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
- func (m *JobTemplateSpec) GetSpec() *k8s_io_api_batch_v1.JobSpec
- func (m *JobTemplateSpec) Marshal() (dAtA []byte, err error)
- func (m *JobTemplateSpec) MarshalTo(dAtA []byte) (int, error)
- func (*JobTemplateSpec) ProtoMessage()
- func (m *JobTemplateSpec) Reset()
- func (m *JobTemplateSpec) Size() (n int)
- func (m *JobTemplateSpec) String() string
- func (m *JobTemplateSpec) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type CronJob ¶
type CronJob struct { // Standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // 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 `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"` // Current status of a cron job. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status // +optional Status *CronJobStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"` XXX_unrecognized []byte `json:"-"` }
CronJob represents the configuration of a single cron job.
func (*CronJob) Descriptor ¶
func (*CronJob) GetMetadata ¶
func (m *CronJob) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
func (*CronJob) GetSpec ¶
func (m *CronJob) GetSpec() *CronJobSpec
func (*CronJob) GetStatus ¶
func (m *CronJob) GetStatus() *CronJobStatus
func (*CronJob) ProtoMessage ¶
func (*CronJob) ProtoMessage()
type CronJobList ¶
type CronJobList struct { // Standard list metadata. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ListMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // items is the list of CronJobs. Items []*CronJob `protobuf:"bytes,2,rep,name=items" json:"items,omitempty"` XXX_unrecognized []byte `json:"-"` }
CronJobList is a collection of cron jobs.
func (*CronJobList) Descriptor ¶
func (*CronJobList) Descriptor() ([]byte, []int)
func (*CronJobList) GetItems ¶
func (m *CronJobList) GetItems() []*CronJob
func (*CronJobList) GetMetadata ¶
func (m *CronJobList) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ListMeta
func (*CronJobList) Marshal ¶
func (m *CronJobList) Marshal() (dAtA []byte, err 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 (m *CronJobList) String() string
func (*CronJobList) Unmarshal ¶
func (m *CronJobList) Unmarshal(dAtA []byte) error
type CronJobSpec ¶
type CronJobSpec struct { // The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. Schedule *string `protobuf:"bytes,1,opt,name=schedule" json:"schedule,omitempty"` // 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 `protobuf:"varint,2,opt,name=startingDeadlineSeconds" json:"startingDeadlineSeconds,omitempty"` // 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 *string `protobuf:"bytes,3,opt,name=concurrencyPolicy" json:"concurrencyPolicy,omitempty"` // This flag tells the controller to suspend subsequent executions, it does // not apply to already started executions. Defaults to false. // +optional Suspend *bool `protobuf:"varint,4,opt,name=suspend" json:"suspend,omitempty"` // Specifies the job that will be created when executing a CronJob. JobTemplate *JobTemplateSpec `protobuf:"bytes,5,opt,name=jobTemplate" json:"jobTemplate,omitempty"` // The number of successful finished jobs to retain. // This is a pointer to distinguish between explicit zero and not specified. // +optional SuccessfulJobsHistoryLimit *int32 `protobuf:"varint,6,opt,name=successfulJobsHistoryLimit" json:"successfulJobsHistoryLimit,omitempty"` // The number of failed finished jobs to retain. // This is a pointer to distinguish between explicit zero and not specified. // +optional FailedJobsHistoryLimit *int32 `protobuf:"varint,7,opt,name=failedJobsHistoryLimit" json:"failedJobsHistoryLimit,omitempty"` XXX_unrecognized []byte `json:"-"` }
CronJobSpec describes how the job execution will look like and when it will actually run.
func (*CronJobSpec) Descriptor ¶
func (*CronJobSpec) Descriptor() ([]byte, []int)
func (*CronJobSpec) GetConcurrencyPolicy ¶
func (m *CronJobSpec) GetConcurrencyPolicy() string
func (*CronJobSpec) GetFailedJobsHistoryLimit ¶ added in v0.3.0
func (m *CronJobSpec) GetFailedJobsHistoryLimit() int32
func (*CronJobSpec) GetJobTemplate ¶
func (m *CronJobSpec) GetJobTemplate() *JobTemplateSpec
func (*CronJobSpec) GetSchedule ¶
func (m *CronJobSpec) GetSchedule() string
func (*CronJobSpec) GetStartingDeadlineSeconds ¶
func (m *CronJobSpec) GetStartingDeadlineSeconds() int64
func (*CronJobSpec) GetSuccessfulJobsHistoryLimit ¶ added in v0.3.0
func (m *CronJobSpec) GetSuccessfulJobsHistoryLimit() int32
func (*CronJobSpec) GetSuspend ¶
func (m *CronJobSpec) GetSuspend() bool
func (*CronJobSpec) Marshal ¶
func (m *CronJobSpec) Marshal() (dAtA []byte, err 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 (m *CronJobSpec) String() string
func (*CronJobSpec) Unmarshal ¶
func (m *CronJobSpec) Unmarshal(dAtA []byte) error
type CronJobStatus ¶
type CronJobStatus struct { // A list of pointers to currently running jobs. // +optional Active []*k8s_io_api_core_v1.ObjectReference `protobuf:"bytes,1,rep,name=active" json:"active,omitempty"` // Information when was the last time the job was successfully scheduled. // +optional LastScheduleTime *k8s_io_apimachinery_pkg_apis_meta_v1.Time `protobuf:"bytes,4,opt,name=lastScheduleTime" json:"lastScheduleTime,omitempty"` XXX_unrecognized []byte `json:"-"` }
CronJobStatus represents the current state of a cron job.
func (*CronJobStatus) Descriptor ¶
func (*CronJobStatus) Descriptor() ([]byte, []int)
func (*CronJobStatus) GetActive ¶
func (m *CronJobStatus) GetActive() []*k8s_io_api_core_v1.ObjectReference
func (*CronJobStatus) GetLastScheduleTime ¶
func (m *CronJobStatus) GetLastScheduleTime() *k8s_io_apimachinery_pkg_apis_meta_v1.Time
func (*CronJobStatus) Marshal ¶
func (m *CronJobStatus) Marshal() (dAtA []byte, err 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 (m *CronJobStatus) String() string
func (*CronJobStatus) Unmarshal ¶
func (m *CronJobStatus) Unmarshal(dAtA []byte) error
type JobTemplate ¶
type JobTemplate struct { // Standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // 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 `protobuf:"bytes,2,opt,name=template" json:"template,omitempty"` XXX_unrecognized []byte `json:"-"` }
JobTemplate describes a template for creating copies of a predefined pod.
func (*JobTemplate) Descriptor ¶
func (*JobTemplate) Descriptor() ([]byte, []int)
func (*JobTemplate) GetMetadata ¶
func (m *JobTemplate) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
func (*JobTemplate) GetTemplate ¶
func (m *JobTemplate) GetTemplate() *JobTemplateSpec
func (*JobTemplate) Marshal ¶
func (m *JobTemplate) Marshal() (dAtA []byte, err 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 (m *JobTemplate) String() string
func (*JobTemplate) Unmarshal ¶
func (m *JobTemplate) Unmarshal(dAtA []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/api-conventions.md#metadata // +optional Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // 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 *k8s_io_api_batch_v1.JobSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"` XXX_unrecognized []byte `json:"-"` }
JobTemplateSpec describes the data a Job should have when created from a template
func (*JobTemplateSpec) Descriptor ¶
func (*JobTemplateSpec) Descriptor() ([]byte, []int)
func (*JobTemplateSpec) GetMetadata ¶
func (m *JobTemplateSpec) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
func (*JobTemplateSpec) GetSpec ¶
func (m *JobTemplateSpec) GetSpec() *k8s_io_api_batch_v1.JobSpec
func (*JobTemplateSpec) Marshal ¶
func (m *JobTemplateSpec) Marshal() (dAtA []byte, err 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 (m *JobTemplateSpec) String() string
func (*JobTemplateSpec) Unmarshal ¶
func (m *JobTemplateSpec) Unmarshal(dAtA []byte) error
Click to show internal directories.
Click to hide internal directories.