k8s_io_api_batch_v1

package
v0.0.0-...-940152b Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

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 Job 

type Job struct {
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	Metadata *v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// Specification of the desired behavior of a job.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Spec *JobSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
	// Current status of a job.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Status *JobStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
}

Job represents the configuration of a single job.

func (*Job) Descriptor 

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

func (*Job) Equal 

func (this *Job) Equal(that interface{}) bool

func (*Job) GetMetadata 

func (m *Job) GetMetadata() *v1.ObjectMeta

func (*Job) GetSpec 

func (m *Job) GetSpec() *JobSpec

func (*Job) GetStatus 

func (m *Job) GetStatus() *JobStatus

func (*Job) GoString 

func (this *Job) GoString() string

func (*Job) Marshal 

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

func (*Job) MarshalTo 

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

func (*Job) MarshalToSizedBuffer 

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

func (*Job) ProtoMessage 

func (*Job) ProtoMessage()

func (*Job) Reset 

func (m *Job) Reset()

func (*Job) Size 

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

func (*Job) String 

func (this *Job) String() string

func (*Job) Unmarshal 

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

func (*Job) XXX_DiscardUnknown 

func (m *Job) XXX_DiscardUnknown()

func (*Job) XXX_Marshal 

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

func (*Job) XXX_Merge 

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

func (*Job) XXX_Size 

func (m *Job) XXX_Size() int

func (*Job) XXX_Unmarshal 

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

type JobCondition 

type JobCondition struct {
	// Type of job condition, Complete or Failed.
	Type string `protobuf:"bytes,1,opt,name=type" json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status string `protobuf:"bytes,2,opt,name=status" json:"status"`
	// Last time the condition was checked.
	// +optional
	LastProbeTime *v1.Time `protobuf:"bytes,3,opt,name=lastProbeTime" json:"lastProbeTime,omitempty"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime *v1.Time `protobuf:"bytes,4,opt,name=lastTransitionTime" json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `protobuf:"bytes,5,opt,name=reason" json:"reason"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `protobuf:"bytes,6,opt,name=message" json:"message"`
}

JobCondition describes current state of a job.

func (*JobCondition) Descriptor 

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

func (*JobCondition) Equal 

func (this *JobCondition) Equal(that interface{}) bool

func (*JobCondition) GetLastProbeTime 

func (m *JobCondition) GetLastProbeTime() *v1.Time

func (*JobCondition) GetLastTransitionTime 

func (m *JobCondition) GetLastTransitionTime() *v1.Time

func (*JobCondition) GetMessage 

func (m *JobCondition) GetMessage() string

func (*JobCondition) GetReason 

func (m *JobCondition) GetReason() string

func (*JobCondition) GetStatus 

func (m *JobCondition) GetStatus() string

func (*JobCondition) GetType 

func (m *JobCondition) GetType() string

func (*JobCondition) GoString 

func (this *JobCondition) GoString() string

func (*JobCondition) Marshal 

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

func (*JobCondition) MarshalTo 

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

func (*JobCondition) MarshalToSizedBuffer 

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

func (*JobCondition) ProtoMessage 

func (*JobCondition) ProtoMessage()

func (*JobCondition) Reset 

func (m *JobCondition) Reset()

func (*JobCondition) Size 

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

func (*JobCondition) String 

func (this *JobCondition) String() string

func (*JobCondition) Unmarshal 

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

func (*JobCondition) XXX_DiscardUnknown 

func (m *JobCondition) XXX_DiscardUnknown()

func (*JobCondition) XXX_Marshal 

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

func (*JobCondition) XXX_Merge 

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

func (*JobCondition) XXX_Size 

func (m *JobCondition) XXX_Size() int

func (*JobCondition) XXX_Unmarshal 

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

type JobList 

type JobList struct {
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	Metadata *v1.ListMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// items is the list of Jobs.
	Items []*Job `protobuf:"bytes,2,rep,name=items" json:"items,omitempty"`
}

JobList is a collection of jobs.

func (*JobList) Descriptor 

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

func (*JobList) Equal 

func (this *JobList) Equal(that interface{}) bool

func (*JobList) GetItems 

func (m *JobList) GetItems() []*Job

func (*JobList) GetMetadata 

func (m *JobList) GetMetadata() *v1.ListMeta

func (*JobList) GoString 

func (this *JobList) GoString() string

func (*JobList) Marshal 

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

func (*JobList) MarshalTo 

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

func (*JobList) MarshalToSizedBuffer 

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

func (*JobList) ProtoMessage 

func (*JobList) ProtoMessage()

func (*JobList) Reset 

func (m *JobList) Reset()

func (*JobList) Size 

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

func (*JobList) String 

func (this *JobList) String() string

func (*JobList) Unmarshal 

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

func (*JobList) XXX_DiscardUnknown 

func (m *JobList) XXX_DiscardUnknown()

func (*JobList) XXX_Marshal 

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

func (*JobList) XXX_Merge 

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

func (*JobList) XXX_Size 

func (m *JobList) XXX_Size() int

func (*JobList) XXX_Unmarshal 

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

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: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Parallelism int32 `protobuf:"varint,1,opt,name=parallelism" json:"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: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Completions int32 `protobuf:"varint,2,opt,name=completions" json:"completions"`
	// Specifies the 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 `protobuf:"varint,3,opt,name=activeDeadlineSeconds" json:"activeDeadlineSeconds"`
	// Specifies the number of retries before marking this job failed.
	// Defaults to 6
	// +optional
	BackoffLimit int32 `protobuf:"varint,7,opt,name=backoffLimit" json:"backoffLimit"`
	// A label query over pods that should match the pod count.
	// Normally, the system sets this field for you.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	Selector *v1.LabelSelector `protobuf:"bytes,4,opt,name=selector" json:"selector,omitempty"`
	// 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: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
	// +optional
	ManualSelector bool `protobuf:"varint,5,opt,name=manualSelector" json:"manualSelector"`
	// Describes the pod that will be created when executing a job.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	Template *v11.PodTemplateSpec `protobuf:"bytes,6,opt,name=template" json:"template,omitempty"`
	// ttlSecondsAfterFinished limits the lifetime of a Job that has finished
	// execution (either Complete or Failed). If this field is set,
	// ttlSecondsAfterFinished after the Job finishes, it is eligible to be
	// automatically deleted. When the Job is being deleted, its lifecycle
	// guarantees (e.g. finalizers) will be honored. If this field is unset,
	// the Job won't be automatically deleted. If this field is set to zero,
	// the Job becomes eligible to be deleted immediately after it finishes.
	// This field is alpha-level and is only honored by servers that enable the
	// TTLAfterFinished feature.
	// +optional
	TtlSecondsAfterFinished int32 `protobuf:"varint,8,opt,name=ttlSecondsAfterFinished" json:"ttlSecondsAfterFinished"`
}

JobSpec describes how the job execution will look like.

func (*JobSpec) Descriptor 

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

func (*JobSpec) Equal 

func (this *JobSpec) Equal(that interface{}) bool

func (*JobSpec) GetActiveDeadlineSeconds 

func (m *JobSpec) GetActiveDeadlineSeconds() int64

func (*JobSpec) GetBackoffLimit 

func (m *JobSpec) GetBackoffLimit() int32

func (*JobSpec) GetCompletions 

func (m *JobSpec) GetCompletions() int32

func (*JobSpec) GetManualSelector 

func (m *JobSpec) GetManualSelector() bool

func (*JobSpec) GetParallelism 

func (m *JobSpec) GetParallelism() int32

func (*JobSpec) GetSelector 

func (m *JobSpec) GetSelector() *v1.LabelSelector

func (*JobSpec) GetTemplate 

func (m *JobSpec) GetTemplate() *v11.PodTemplateSpec

func (*JobSpec) GetTtlSecondsAfterFinished 

func (m *JobSpec) GetTtlSecondsAfterFinished() int32

func (*JobSpec) GoString 

func (this *JobSpec) GoString() string

func (*JobSpec) Marshal 

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

func (*JobSpec) MarshalTo 

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

func (*JobSpec) MarshalToSizedBuffer 

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

func (*JobSpec) ProtoMessage 

func (*JobSpec) ProtoMessage()

func (*JobSpec) Reset 

func (m *JobSpec) Reset()

func (*JobSpec) Size 

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

func (*JobSpec) String 

func (this *JobSpec) String() string

func (*JobSpec) Unmarshal 

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

func (*JobSpec) XXX_DiscardUnknown 

func (m *JobSpec) XXX_DiscardUnknown()

func (*JobSpec) XXX_Marshal 

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

func (*JobSpec) XXX_Merge 

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

func (*JobSpec) XXX_Size 

func (m *JobSpec) XXX_Size() int

func (*JobSpec) XXX_Unmarshal 

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

type JobStatus 

type JobStatus struct {
	// The latest available observations of an object's current state.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []*JobCondition `protobuf:"bytes,1,rep,name=conditions" json:"conditions,omitempty"`
	// 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 *v1.Time `protobuf:"bytes,2,opt,name=startTime" json:"startTime,omitempty"`
	// 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 *v1.Time `protobuf:"bytes,3,opt,name=completionTime" json:"completionTime,omitempty"`
	// The number of actively running pods.
	// +optional
	Active int32 `protobuf:"varint,4,opt,name=active" json:"active"`
	// The number of pods which reached phase Succeeded.
	// +optional
	Succeeded int32 `protobuf:"varint,5,opt,name=succeeded" json:"succeeded"`
	// The number of pods which reached phase Failed.
	// +optional
	Failed int32 `protobuf:"varint,6,opt,name=failed" json:"failed"`
}

JobStatus represents the current state of a Job.

func (*JobStatus) Descriptor 

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

func (*JobStatus) Equal 

func (this *JobStatus) Equal(that interface{}) bool

func (*JobStatus) GetActive 

func (m *JobStatus) GetActive() int32

func (*JobStatus) GetCompletionTime 

func (m *JobStatus) GetCompletionTime() *v1.Time

func (*JobStatus) GetConditions 

func (m *JobStatus) GetConditions() []*JobCondition

func (*JobStatus) GetFailed 

func (m *JobStatus) GetFailed() int32

func (*JobStatus) GetStartTime 

func (m *JobStatus) GetStartTime() *v1.Time

func (*JobStatus) GetSucceeded 

func (m *JobStatus) GetSucceeded() int32

func (*JobStatus) GoString 

func (this *JobStatus) GoString() string

func (*JobStatus) Marshal 

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

func (*JobStatus) MarshalTo 

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

func (*JobStatus) MarshalToSizedBuffer 

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

func (*JobStatus) ProtoMessage 

func (*JobStatus) ProtoMessage()

func (*JobStatus) Reset 

func (m *JobStatus) Reset()

func (*JobStatus) Size 

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

func (*JobStatus) String 

func (this *JobStatus) String() string

func (*JobStatus) Unmarshal 

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

func (*JobStatus) XXX_DiscardUnknown 

func (m *JobStatus) XXX_DiscardUnknown()

func (*JobStatus) XXX_Marshal 

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

func (*JobStatus) XXX_Merge 

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

func (*JobStatus) XXX_Size 

func (m *JobStatus) XXX_Size() int

func (*JobStatus) XXX_Unmarshal 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.