v2alpha1

package
v3.6.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package v2alpha1 is a generated protocol buffer package.

It is generated from these files:

k8s.io/kubernetes/pkg/apis/batch/v2alpha1/generated.proto

It has these top-level messages:

CronJob
CronJobList
CronJobSpec
CronJobStatus
JobTemplate
JobTemplateSpec

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")
)
View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addDefaultingFuncs, addConversionFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v2alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_batch_CronJobList_To_v2alpha1_CronJobList

func Convert_batch_CronJobList_To_v2alpha1_CronJobList(in *batch.CronJobList, out *CronJobList, s conversion.Scope) error

func Convert_batch_CronJobSpec_To_v2alpha1_CronJobSpec

func Convert_batch_CronJobSpec_To_v2alpha1_CronJobSpec(in *batch.CronJobSpec, out *CronJobSpec, s conversion.Scope) error

func Convert_batch_CronJobStatus_To_v2alpha1_CronJobStatus

func Convert_batch_CronJobStatus_To_v2alpha1_CronJobStatus(in *batch.CronJobStatus, out *CronJobStatus, s conversion.Scope) error

func Convert_batch_CronJob_To_v2alpha1_CronJob

func Convert_batch_CronJob_To_v2alpha1_CronJob(in *batch.CronJob, out *CronJob, s conversion.Scope) error

func Convert_batch_JobTemplateSpec_To_v2alpha1_JobTemplateSpec

func Convert_batch_JobTemplateSpec_To_v2alpha1_JobTemplateSpec(in *batch.JobTemplateSpec, out *JobTemplateSpec, s conversion.Scope) error

func Convert_batch_JobTemplate_To_v2alpha1_JobTemplate

func Convert_batch_JobTemplate_To_v2alpha1_JobTemplate(in *batch.JobTemplate, out *JobTemplate, s conversion.Scope) error

func Convert_v2alpha1_CronJobList_To_batch_CronJobList

func Convert_v2alpha1_CronJobList_To_batch_CronJobList(in *CronJobList, out *batch.CronJobList, s conversion.Scope) error

func Convert_v2alpha1_CronJobSpec_To_batch_CronJobSpec

func Convert_v2alpha1_CronJobSpec_To_batch_CronJobSpec(in *CronJobSpec, out *batch.CronJobSpec, s conversion.Scope) error

func Convert_v2alpha1_CronJobStatus_To_batch_CronJobStatus

func Convert_v2alpha1_CronJobStatus_To_batch_CronJobStatus(in *CronJobStatus, out *batch.CronJobStatus, s conversion.Scope) error

func Convert_v2alpha1_CronJob_To_batch_CronJob

func Convert_v2alpha1_CronJob_To_batch_CronJob(in *CronJob, out *batch.CronJob, s conversion.Scope) error

func Convert_v2alpha1_JobTemplateSpec_To_batch_JobTemplateSpec

func Convert_v2alpha1_JobTemplateSpec_To_batch_JobTemplateSpec(in *JobTemplateSpec, out *batch.JobTemplateSpec, s conversion.Scope) error

func Convert_v2alpha1_JobTemplate_To_batch_JobTemplate

func Convert_v2alpha1_JobTemplate_To_batch_JobTemplate(in *JobTemplate, out *batch.JobTemplate, s conversion.Scope) error

func DeepCopy_v2alpha1_CronJob

func DeepCopy_v2alpha1_CronJob(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v2alpha1_CronJobList

func DeepCopy_v2alpha1_CronJobList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v2alpha1_CronJobSpec

func DeepCopy_v2alpha1_CronJobSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v2alpha1_CronJobStatus

func DeepCopy_v2alpha1_CronJobStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v2alpha1_JobTemplate

func DeepCopy_v2alpha1_JobTemplate(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_v2alpha1_JobTemplateSpec

func DeepCopy_v2alpha1_JobTemplateSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func RegisterConversions

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func SetDefaults_CronJob

func SetDefaults_CronJob(obj *CronJob)

func SetObjectDefaults_CronJob

func SetObjectDefaults_CronJob(in *CronJob)

func SetObjectDefaults_CronJobList

func SetObjectDefaults_CronJobList(in *CronJobList)

func SetObjectDefaults_JobTemplate

func SetObjectDefaults_JobTemplate(in *JobTemplate)

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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec is a structure defining the expected behavior of a job, including the schedule.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	// +optional
	Spec CronJobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Status is a structure describing current status of a job.
	// More info: http://releases.k8s.io/HEAD/docs/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) 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) 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

type CronJobList

type CronJobList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

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

CronJobList is a collection of cron jobs.

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) 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

type CronJobSpec

type CronJobSpec struct {

	// Schedule contains 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"`

	// ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
	// +optional
	ConcurrencyPolicy ConcurrencyPolicy `json:"concurrencyPolicy,omitempty" protobuf:"bytes,3,opt,name=concurrencyPolicy,casttype=ConcurrencyPolicy"`

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

	// JobTemplate is the object that describes 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) 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) 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

type CronJobStatus

type CronJobStatus struct {
	// Active holds pointers to currently running jobs.
	// +optional
	Active []v1.ObjectReference `json:"active,omitempty" protobuf:"bytes,1,rep,name=active"`

	// LastScheduleTime keeps information of 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) 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) 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

type JobTemplate

type JobTemplate struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Template defines jobs that will be created from this template
	// http://releases.k8s.io/HEAD/docs/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) 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) 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

type JobTemplateSpec

type JobTemplateSpec struct {
	// Standard object's metadata of the jobs created from this template.
	// More info: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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) 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) 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

Jump to

Keyboard shortcuts

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