api: k8s.io/api/batch/v2alpha1 Index | Files

package v2alpha1

import "k8s.io/api/batch/v2alpha1"

Package v2alpha1 is a generated protocol buffer package.

It is generated from these files:

k8s.io/kubernetes/vendor/k8s.io/api/batch/v2alpha1/generated.proto

It has these top-level messages:

CronJob
CronJobList
CronJobSpec
CronJobStatus
JobTemplate
JobTemplateSpec

Index

Package Files

doc.go generated.pb.go register.go types.go types_swagger_doc_generated.go zz_generated.deepcopy.go

Constants

const GroupName = "batch"

GroupName is the group name use in this package

Variables

var (
    ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
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
)
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v2alpha1"}

SchemeGroupVersion is group version used to register these objects

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

type ConcurrencyPolicy Uses

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 Uses

type CronJob 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 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/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) DeepCopy Uses

func (in *CronJob) DeepCopy() *CronJob

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

func (*CronJob) DeepCopyInto Uses

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 Uses

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

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

func (*CronJob) Descriptor Uses

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

func (*CronJob) Marshal Uses

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

func (*CronJob) MarshalTo Uses

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

func (*CronJob) ProtoMessage Uses

func (*CronJob) ProtoMessage()

func (*CronJob) Reset Uses

func (m *CronJob) Reset()

func (*CronJob) Size Uses

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

func (*CronJob) String Uses

func (this *CronJob) String() string

func (CronJob) SwaggerDoc Uses

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

func (*CronJob) Unmarshal Uses

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

type CronJobList Uses

type CronJobList 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 []CronJob `json:"items" protobuf:"bytes,2,rep,name=items"`
}

CronJobList is a collection of cron jobs.

func (*CronJobList) DeepCopy Uses

func (in *CronJobList) DeepCopy() *CronJobList

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

func (*CronJobList) DeepCopyInto Uses

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 Uses

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

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

func (*CronJobList) Descriptor Uses

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

func (*CronJobList) Marshal Uses

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

func (*CronJobList) MarshalTo Uses

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

func (*CronJobList) ProtoMessage Uses

func (*CronJobList) ProtoMessage()

func (*CronJobList) Reset Uses

func (m *CronJobList) Reset()

func (*CronJobList) Size Uses

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

func (*CronJobList) String Uses

func (this *CronJobList) String() string

func (CronJobList) SwaggerDoc Uses

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

func (*CronJobList) Unmarshal Uses

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

type CronJobSpec Uses

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.
    // +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.
    // +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 Uses

func (in *CronJobSpec) DeepCopy() *CronJobSpec

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

func (*CronJobSpec) DeepCopyInto Uses

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 Uses

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

func (*CronJobSpec) Marshal Uses

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

func (*CronJobSpec) MarshalTo Uses

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

func (*CronJobSpec) ProtoMessage Uses

func (*CronJobSpec) ProtoMessage()

func (*CronJobSpec) Reset Uses

func (m *CronJobSpec) Reset()

func (*CronJobSpec) Size Uses

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

func (*CronJobSpec) String Uses

func (this *CronJobSpec) String() string

func (CronJobSpec) SwaggerDoc Uses

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

func (*CronJobSpec) Unmarshal Uses

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

type CronJobStatus Uses

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 Uses

func (in *CronJobStatus) DeepCopy() *CronJobStatus

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

func (*CronJobStatus) DeepCopyInto Uses

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 Uses

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

func (*CronJobStatus) Marshal Uses

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

func (*CronJobStatus) MarshalTo Uses

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

func (*CronJobStatus) ProtoMessage Uses

func (*CronJobStatus) ProtoMessage()

func (*CronJobStatus) Reset Uses

func (m *CronJobStatus) Reset()

func (*CronJobStatus) Size Uses

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

func (*CronJobStatus) String Uses

func (this *CronJobStatus) String() string

func (CronJobStatus) SwaggerDoc Uses

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

func (*CronJobStatus) Unmarshal Uses

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

type JobTemplate Uses

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

    // 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 `json:"template,omitempty" protobuf:"bytes,2,opt,name=template"`
}

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

func (*JobTemplate) DeepCopy Uses

func (in *JobTemplate) DeepCopy() *JobTemplate

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

func (*JobTemplate) DeepCopyInto Uses

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 Uses

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

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

func (*JobTemplate) Descriptor Uses

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

func (*JobTemplate) Marshal Uses

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

func (*JobTemplate) MarshalTo Uses

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

func (*JobTemplate) ProtoMessage Uses

func (*JobTemplate) ProtoMessage()

func (*JobTemplate) Reset Uses

func (m *JobTemplate) Reset()

func (*JobTemplate) Size Uses

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

func (*JobTemplate) String Uses

func (this *JobTemplate) String() string

func (JobTemplate) SwaggerDoc Uses

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

func (*JobTemplate) Unmarshal Uses

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

type JobTemplateSpec Uses

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
    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/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 Uses

func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec

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

func (*JobTemplateSpec) DeepCopyInto Uses

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 Uses

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

func (*JobTemplateSpec) Marshal Uses

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

func (*JobTemplateSpec) MarshalTo Uses

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

func (*JobTemplateSpec) ProtoMessage Uses

func (*JobTemplateSpec) ProtoMessage()

func (*JobTemplateSpec) Reset Uses

func (m *JobTemplateSpec) Reset()

func (*JobTemplateSpec) Size Uses

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

func (*JobTemplateSpec) String Uses

func (this *JobTemplateSpec) String() string

func (JobTemplateSpec) SwaggerDoc Uses

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

func (*JobTemplateSpec) Unmarshal Uses

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

Package v2alpha1 imports 11 packages (graph) and is imported by 92 packages. Updated 2019-06-01. Refresh now. Tools for package owners.