Documentation
¶
Overview ¶
Package v1 is a generated protocol buffer package.
It is generated from these files:
k8s.io/kubernetes/pkg/apis/batch/v1/generated.proto
It has these top-level messages:
Job JobCondition JobList JobSpec JobStatus
Index ¶
- Constants
- Variables
- func Convert_batch_JobCondition_To_v1_JobCondition(in *batch.JobCondition, out *JobCondition, s conversion.Scope) error
- func Convert_batch_JobList_To_v1_JobList(in *batch.JobList, out *JobList, s conversion.Scope) error
- func Convert_batch_JobSpec_To_v1_JobSpec(in *batch.JobSpec, out *JobSpec, s conversion.Scope) error
- func Convert_batch_JobStatus_To_v1_JobStatus(in *batch.JobStatus, out *JobStatus, s conversion.Scope) error
- func Convert_batch_Job_To_v1_Job(in *batch.Job, out *Job, s conversion.Scope) error
- func Convert_v1_JobCondition_To_batch_JobCondition(in *JobCondition, out *batch.JobCondition, s conversion.Scope) error
- func Convert_v1_JobList_To_batch_JobList(in *JobList, out *batch.JobList, s conversion.Scope) error
- func Convert_v1_JobSpec_To_batch_JobSpec(in *JobSpec, out *batch.JobSpec, s conversion.Scope) error
- func Convert_v1_JobStatus_To_batch_JobStatus(in *JobStatus, out *batch.JobStatus, s conversion.Scope) error
- func Convert_v1_Job_To_batch_Job(in *Job, out *batch.Job, s conversion.Scope) error
- func DeepCopy_v1_Job(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_JobCondition(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_JobList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_JobSpec(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_JobStatus(in interface{}, out interface{}, c *conversion.Cloner) error
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- func SetDefaults_Job(obj *Job)
- func SetObjectDefaults_Job(in *Job)
- func SetObjectDefaults_JobList(in *JobList)
- type Job
- func (x *Job) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *Job) CodecEncodeSelf(e *codec1978.Encoder)
- func (*Job) Descriptor() ([]byte, []int)
- func (m *Job) Marshal() (dAtA []byte, err error)
- func (m *Job) MarshalTo(dAtA []byte) (int, error)
- func (*Job) ProtoMessage()
- func (m *Job) Reset()
- func (m *Job) Size() (n int)
- func (this *Job) String() string
- func (Job) SwaggerDoc() map[string]string
- func (m *Job) Unmarshal(dAtA []byte) error
- type JobCondition
- func (x *JobCondition) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *JobCondition) CodecEncodeSelf(e *codec1978.Encoder)
- func (*JobCondition) Descriptor() ([]byte, []int)
- func (m *JobCondition) Marshal() (dAtA []byte, err error)
- func (m *JobCondition) MarshalTo(dAtA []byte) (int, error)
- func (*JobCondition) ProtoMessage()
- func (m *JobCondition) Reset()
- func (m *JobCondition) Size() (n int)
- func (this *JobCondition) String() string
- func (JobCondition) SwaggerDoc() map[string]string
- func (m *JobCondition) Unmarshal(dAtA []byte) error
- type JobConditionType
- type JobList
- func (x *JobList) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *JobList) CodecEncodeSelf(e *codec1978.Encoder)
- func (*JobList) Descriptor() ([]byte, []int)
- func (m *JobList) Marshal() (dAtA []byte, err error)
- func (m *JobList) MarshalTo(dAtA []byte) (int, error)
- func (*JobList) ProtoMessage()
- func (m *JobList) Reset()
- func (m *JobList) Size() (n int)
- func (this *JobList) String() string
- func (JobList) SwaggerDoc() map[string]string
- func (m *JobList) Unmarshal(dAtA []byte) error
- type JobSpec
- func (x *JobSpec) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *JobSpec) CodecEncodeSelf(e *codec1978.Encoder)
- func (*JobSpec) Descriptor() ([]byte, []int)
- func (m *JobSpec) Marshal() (dAtA []byte, err error)
- func (m *JobSpec) MarshalTo(dAtA []byte) (int, error)
- func (*JobSpec) ProtoMessage()
- func (m *JobSpec) Reset()
- func (m *JobSpec) Size() (n int)
- func (this *JobSpec) String() string
- func (JobSpec) SwaggerDoc() map[string]string
- func (m *JobSpec) Unmarshal(dAtA []byte) error
- type JobStatus
- func (x *JobStatus) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *JobStatus) CodecEncodeSelf(e *codec1978.Encoder)
- func (*JobStatus) Descriptor() ([]byte, []int)
- func (m *JobStatus) Marshal() (dAtA []byte, err error)
- func (m *JobStatus) MarshalTo(dAtA []byte) (int, error)
- func (*JobStatus) ProtoMessage()
- func (m *JobStatus) Reset()
- func (m *JobStatus) Size() (n int)
- func (this *JobStatus) String() string
- func (JobStatus) SwaggerDoc() map[string]string
- func (m *JobStatus) Unmarshal(dAtA []byte) error
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 ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addDefaultingFuncs, addConversionFuncs) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_batch_JobCondition_To_v1_JobCondition ¶ added in v1.3.0
func Convert_batch_JobCondition_To_v1_JobCondition(in *batch.JobCondition, out *JobCondition, s conversion.Scope) error
Convert_batch_JobCondition_To_v1_JobCondition is an autogenerated conversion function.
func Convert_batch_JobList_To_v1_JobList ¶ added in v1.3.0
Convert_batch_JobList_To_v1_JobList is an autogenerated conversion function.
func Convert_batch_JobSpec_To_v1_JobSpec ¶ added in v1.3.0
func Convert_batch_JobStatus_To_v1_JobStatus ¶ added in v1.3.0
func Convert_batch_JobStatus_To_v1_JobStatus(in *batch.JobStatus, out *JobStatus, s conversion.Scope) error
Convert_batch_JobStatus_To_v1_JobStatus is an autogenerated conversion function.
func Convert_batch_Job_To_v1_Job ¶ added in v1.3.0
Convert_batch_Job_To_v1_Job is an autogenerated conversion function.
func Convert_v1_JobCondition_To_batch_JobCondition ¶ added in v1.3.0
func Convert_v1_JobCondition_To_batch_JobCondition(in *JobCondition, out *batch.JobCondition, s conversion.Scope) error
Convert_v1_JobCondition_To_batch_JobCondition is an autogenerated conversion function.
func Convert_v1_JobList_To_batch_JobList ¶ added in v1.3.0
Convert_v1_JobList_To_batch_JobList is an autogenerated conversion function.
func Convert_v1_JobSpec_To_batch_JobSpec ¶ added in v1.3.0
func Convert_v1_JobStatus_To_batch_JobStatus ¶ added in v1.3.0
func Convert_v1_JobStatus_To_batch_JobStatus(in *JobStatus, out *batch.JobStatus, s conversion.Scope) error
Convert_v1_JobStatus_To_batch_JobStatus is an autogenerated conversion function.
func Convert_v1_Job_To_batch_Job ¶ added in v1.3.0
Convert_v1_Job_To_batch_Job is an autogenerated conversion function.
func DeepCopy_v1_Job ¶ added in v1.3.0
func DeepCopy_v1_Job(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_JobCondition ¶ added in v1.3.0
func DeepCopy_v1_JobCondition(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_JobList ¶ added in v1.3.0
func DeepCopy_v1_JobList(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_JobSpec ¶ added in v1.3.0
func DeepCopy_v1_JobSpec(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1_JobStatus ¶ added in v1.3.0
func DeepCopy_v1_JobStatus(in interface{}, out interface{}, c *conversion.Cloner) error
func RegisterConversions ¶ added in v1.4.2
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies ¶ added in v1.4.2
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDefaults ¶ added in v1.5.1
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 ¶ added in v1.6.0
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
func SetDefaults_Job ¶ added in v1.3.0
func SetDefaults_Job(obj *Job)
func SetObjectDefaults_Job ¶ added in v1.5.1
func SetObjectDefaults_Job(in *Job)
func SetObjectDefaults_JobList ¶ added in v1.5.1
func SetObjectDefaults_JobList(in *JobList)
Types ¶
type Job ¶
type Job 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"` // Specification of the desired behavior of a job. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // +optional Spec JobSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` // Current status of a job. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status // +optional Status JobStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` }
Job represents the configuration of a single job.
func (*Job) CodecDecodeSelf ¶
func (*Job) CodecEncodeSelf ¶
func (*Job) Descriptor ¶ added in v1.4.2
func (*Job) ProtoMessage ¶ added in v1.3.0
func (*Job) ProtoMessage()
func (Job) SwaggerDoc ¶
type JobCondition ¶
type JobCondition struct { // Type of job condition, Complete or Failed. Type JobConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=JobConditionType"` // Status of the condition, one of True, False, Unknown. Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/kubernetes/pkg/api/v1.ConditionStatus"` // Last time the condition was checked. // +optional LastProbeTime metav1.Time `json:"lastProbeTime,omitempty" protobuf:"bytes,3,opt,name=lastProbeTime"` // Last time the condition transit from one status to another. // +optional LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,4,opt,name=lastTransitionTime"` // (brief) reason for the condition's last transition. // +optional Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"` // Human readable message indicating details about last transition. // +optional Message string `json:"message,omitempty" protobuf:"bytes,6,opt,name=message"` }
JobCondition describes current state of a job.
func (*JobCondition) CodecDecodeSelf ¶
func (x *JobCondition) CodecDecodeSelf(d *codec1978.Decoder)
func (*JobCondition) CodecEncodeSelf ¶
func (x *JobCondition) CodecEncodeSelf(e *codec1978.Encoder)
func (*JobCondition) Descriptor ¶ added in v1.4.2
func (*JobCondition) Descriptor() ([]byte, []int)
func (*JobCondition) Marshal ¶ added in v1.3.0
func (m *JobCondition) Marshal() (dAtA []byte, err error)
func (*JobCondition) MarshalTo ¶ added in v1.3.0
func (m *JobCondition) MarshalTo(dAtA []byte) (int, error)
func (*JobCondition) ProtoMessage ¶ added in v1.3.0
func (*JobCondition) ProtoMessage()
func (*JobCondition) Reset ¶ added in v1.3.0
func (m *JobCondition) Reset()
func (*JobCondition) Size ¶ added in v1.3.0
func (m *JobCondition) Size() (n int)
func (*JobCondition) String ¶ added in v1.3.0
func (this *JobCondition) String() string
func (JobCondition) SwaggerDoc ¶
func (JobCondition) SwaggerDoc() map[string]string
func (*JobCondition) Unmarshal ¶ added in v1.3.0
func (m *JobCondition) Unmarshal(dAtA []byte) error
type JobConditionType ¶
type JobConditionType string
const ( // JobComplete means the job has completed its execution. JobComplete JobConditionType = "Complete" // JobFailed means the job has failed its execution. JobFailed JobConditionType = "Failed" )
These are valid conditions of a job.
func (*JobConditionType) CodecDecodeSelf ¶
func (x *JobConditionType) CodecDecodeSelf(d *codec1978.Decoder)
func (JobConditionType) CodecEncodeSelf ¶
func (x JobConditionType) CodecEncodeSelf(e *codec1978.Encoder)
type JobList ¶
type JobList 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 Jobs. Items []Job `json:"items" protobuf:"bytes,2,rep,name=items"` }
JobList is a collection of jobs.
func (*JobList) CodecDecodeSelf ¶
func (*JobList) CodecEncodeSelf ¶
func (*JobList) Descriptor ¶ added in v1.4.2
func (*JobList) ProtoMessage ¶ added in v1.3.0
func (*JobList) ProtoMessage()
func (JobList) SwaggerDoc ¶
type JobSpec ¶
type JobSpec struct { // Specifies the maximum desired number of pods the job should // run at any given time. The actual number of pods running in steady state will // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // i.e. when the work left to do is less than max parallelism. // More info: http://kubernetes.io/docs/user-guide/jobs // +optional Parallelism *int32 `json:"parallelism,omitempty" protobuf:"varint,1,opt,name=parallelism"` // Specifies the desired number of successfully finished pods the // job should be run with. Setting to nil means that the success of any // pod signals the success of all pods, and allows parallelism to have any positive // value. Setting to 1 means that parallelism is limited to 1 and the success of that // pod signals the success of the job. // More info: http://kubernetes.io/docs/user-guide/jobs // +optional Completions *int32 `json:"completions,omitempty" protobuf:"varint,2,opt,name=completions"` // Optional duration in seconds relative to the startTime that the job may be active // before the system tries to terminate it; value must be positive integer // +optional ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty" protobuf:"varint,3,opt,name=activeDeadlineSeconds"` // A label query over pods that should match the pod count. // Normally, the system sets this field for you. // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors // +optional Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,4,opt,name=selector"` // manualSelector controls generation of pod labels and pod selectors. // Leave `manualSelector` unset unless you are certain what you are doing. // When false or unset, the system pick labels unique to this job // and appends those labels to the pod template. When true, // the user is responsible for picking unique labels and specifying // the selector. Failure to pick a unique label may cause this // and other jobs to not function correctly. However, You may see // `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` // API. // More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md // +optional ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"` // Describes the pod that will be created when executing a job. // More info: http://kubernetes.io/docs/user-guide/jobs Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,6,opt,name=template"` }
JobSpec describes how the job execution will look like.
func (*JobSpec) CodecDecodeSelf ¶
func (*JobSpec) CodecEncodeSelf ¶
func (*JobSpec) Descriptor ¶ added in v1.4.2
func (*JobSpec) ProtoMessage ¶ added in v1.3.0
func (*JobSpec) ProtoMessage()
func (JobSpec) SwaggerDoc ¶
type JobStatus ¶
type JobStatus struct { // The latest available observations of an object's current state. // More info: http://kubernetes.io/docs/user-guide/jobs // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // Represents time when the job was acknowledged by the job controller. // It is not guaranteed to be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. // +optional StartTime *metav1.Time `json:"startTime,omitempty" protobuf:"bytes,2,opt,name=startTime"` // Represents time when the job was completed. It is not guaranteed to // be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. // +optional CompletionTime *metav1.Time `json:"completionTime,omitempty" protobuf:"bytes,3,opt,name=completionTime"` // The number of actively running pods. // +optional Active int32 `json:"active,omitempty" protobuf:"varint,4,opt,name=active"` // The number of pods which reached phase Succeeded. // +optional Succeeded int32 `json:"succeeded,omitempty" protobuf:"varint,5,opt,name=succeeded"` // The number of pods which reached phase Failed. // +optional Failed int32 `json:"failed,omitempty" protobuf:"varint,6,opt,name=failed"` }
JobStatus represents the current state of a Job.
func (*JobStatus) CodecDecodeSelf ¶
func (*JobStatus) CodecEncodeSelf ¶
func (*JobStatus) Descriptor ¶ added in v1.4.2
func (*JobStatus) ProtoMessage ¶ added in v1.3.0
func (*JobStatus) ProtoMessage()